OKÇ®°ü

IT/OT/CT/DTÈÚºÏ | ÖÇÄÜÔì×÷Ôõô¸É£¿¹ú±êΪÄãָ·£¡£¨Èý£©

2023-07-25 16:32

ÖÇÄÜÔì×÷Ö÷Ìâ¹ú¶È³ß¶ÈGB/T 42405.1-2023¡¶ÖÇÄÜÔì×÷ÀûÓû¥Áª µÚ1²¿ÃÅ£º¼¯³É¼¼ÊõÒªÇó¡·Ä¿Ç°ÒÑÕýʽ°ä²¼¡£


¸Ã³ß¶È½â¾öÁËÖÇÄÜÔì×÷¡¢¹¤Òµ»¥Áª³¡¾°ÖеÄÍò¹ú˵»°»¥·­ÒëµÄÎÊÌâ £¬¹¹½¨Ò»¸ö¶àÔ´Ò칹ϵͳµÄ¡°Í¬Éù·­ÒëÆ½Ì¨¡± £¬ÖúÁ¦ÆóҵʵÏÖÈ«ÃæµÄÖÇÄÜÔì×÷¡£


½ÓÏÂÀ´ £¬¾ÍGB/T 42405.1-2023¡¶ÖÇÄÜÔì×÷ÀûÓû¥Áª µÚ1²¿ÃÅ£º¼¯³É¼¼ÊõÒªÇó¡·ÓйØÄÚÈݳÖÐø·ÖÏí£º

¨‹


Ê¢¿ª·þÎñ×ÜÏßÖ°Äܲο¼
PART.1
API°ä²¼Æ½Ì¨

ͼƬ
ͼƬ


01
·þÎñÖÎÀí

ͼƬ

API°ä²¼Æ½Ì¨ÒËÓÐÒÔÏÂÖ°ÄÜ£º

a)×¢²á½ÓÈ룺ÌṩAPIµÄ×¢²áÈë¿Ú £¬Í¨¹ýÊèµ¼Ò³ÃæÊµÏÖÐÂAPIµÄ×¢²áÓëµ÷Õû £¬Ìṩº¬Web ServiceÓëRestfulµÄ´ó¾Ö×¢²á £¬ÇÒÖ§³ÖHttpÓëHttpsÒªÇóģʽ   £»


b)ÖÜÆÚÖÎÀí£ºÊµÏÖAPI½Ó¿ÚµÄÖÜÆÚÖÎÀí £¬ÖÎÀíAPI×¢²áºó¸÷Àà״̬µÄ½ÚÔì £¬¶ÔAPIʵÏÖ´´½¨¡¢°ä²¼¡¢¹ýÆÚ¡¢ÍËÒ۵ĽÚÔì¼°±   £»¤   £»


c)¶©ÔÄÖÎÀí£º²é¿´µ±Ç°´¦Óڰ䲼״̬µÄAPI £¬±»¶©ÔĵÄʹÓÃÇé¿ö £¬ÓÉË­¶©ÔÄÁËÀ´×ÔË­µÄAPI¾ßÌåÐÅÏ¢ £¬Äܹ»ÓÉÖÎÀíÔ±¶ÔÒѶ©ÔĵÄAPI½øÐйýÎʽâ³ý¶©ÔÄ   £»


d)°æ±¾ÖÎÀí£º¶ÔÒÑ×¢²áµÄͳһ×éÖ¯°ä²¼µÄÒ»Ñù½Ó¿ÚµÄAPIʵÏÖ°æ±¾½ÚÔì   £»


e)×ÊÁÏÖÎÀí£º¶ÔÒÑ×¢²á°ä²¼³É¹¦µÄAPI £¬Ìṩ×ÊÁÏÖÎÀíµÄÊØ»¤²Ù×÷ £¬ÃèÊöAPIµÄʹÓÃÓë½éÉܵľßÌå×¢Ã÷   £»


f)½Ó¿Ú²âÊÔ£º¾ß±¸Ê¹ÓÃ״̬ϵÄAPI²âÊÔÄÜÁ¦ £¬ÌáÔç·¢ÏÖAPI²âÊÔŲÓõÄʹÓÃÇé¿ö   £»


g)½Ó¿ÚĿ¼£º³öÏÖËùÓÐ״̬ϵÄAPI½Ó¿ÚĿ¼Çåµ¥¡£


02
»ù´¡ÖÎÀí

ͼƬ

»ù´¡ÖÎÀíÒËÓÐÒÔÏÂÖ°ÄÜ£º

a)ÕË»§×¢²á£ºÌṩÐÂÓû§µÇ¼ÇÈë¿Ú £¬Â¼ÈëÆóÒµ»òÓ×ÎÒÕË»§ÐÅÏ¢   £»


b)ÐÅÏ¢Åú¸Ä£º³ýÕ˺űíµÄ £¬ÆóÒµ»òÓ×ÎÒÐÅÏ¢ÓëÃÜÂëµÄµ÷Õû   £»


c)·ÖÅäȨÏÞ£ºÓÉÖÎÀíÔ±µ÷»»»òÅäÖÃÓû§¶ÔAPI²Ù×÷µÄȨÏÞ £¬API²Ù×÷µÄȨÏÞÔ̺¬£¨¶©ÔÄ¡¢°ä²¼¡¢¶©ÔÄ/°ä²¼£©×é³É¡£


03
Á÷Á¿ÖÎÀí

ͼƬ

Õë¶Ô·ÖÆçAPI·þÎñµÄ¸ö±ð²î¾à £¬¶ÔÆäAPI·þÎñÔÚʹÓÃÏ޶ȵÄÕ½ÊõÉÏ £¬ÌåÏÖ¶ÔÆä½øÐÐÁ÷Á¿µÄ½Ó¼û½ÚÔìÓëÁ÷Á¿µÄÖÎÀíÖ°ÄÜ £¬²¢Ìṩ֧³Ö¸ß²¢·¢¸ß½Ó¼ûÁ¿APIÍø¹Ø·¨Ê½ÔÚÉϲãÁ÷Á¿µÄ·À»¤ÄÜÁ¦¡£


04
°²È«ÖÎÀí

ͼƬ

ÖÎÀíËùÓзþÎñÒªÇ󷽵ݲȫŲÓÃÐÐΪ £¬°²È«ÒÔ¼°½Ó¼ûÁîÅÆÓйصIJÙ×÷¡£Gateway ÓëÃÜÔ¿ÏνÓÀ´²é³­¶©ÔĺÍŲÓÃAPIµÄOAuth2ÁîÅÆµÄÊÇ·ñÓÐЧÐÔ¡£


05
¹æ¶¨ÖÎÀí

ͼƬ

¶ÔAPI·þÎñŲÓúóÖ´Ðй涨ÖÎÀí½ÚÔìµÄÐÐΪ £¬Ã¿¸öAPI·þÎñ¶¼³öȱʡÖнéÁ÷ £¬ÔÚÿ¸öAPI±»Å²ÓÃʱִÐС£Ê¹ÓÃÖнéÁ÷µÄ¼ÓÇ¿¹æ¶¨µÄ¶¨Ô컯ÄÜÁ¦¡£


06
ÁîÅÆÖÎÀí

ͼƬ

ÌṩHttp»òHttpsÍ·²ÎÊýʵÏÖ´«ÊäµÄ¶¯Ì¬Êý×Öǩ֤ÈÏÖ¤¡£ÔÚÌáÒéÒªÇóʱ £¬ÓÉ·þÎñÒªÇó·½ÌṩÁîÅÆ £¬¶ÔÓÚÁîÅÆÖÎÀíÓÉÌáÒé·½×ÔÐÐÊØ»¤¡£


ͼƬ

¡ø CPSÈÚͨ»¥Áª×ÜÏ߼ܹ¹


PART.2
APIÉÌµêÆ½Ì¨

ͼƬ
ͼƬ

APIÉÌµêÆ½Ì¨ÒËÓÐÒÔÏÂÖ°ÄÜ£º

a)½Ó¿ÚËÑË÷£ºÆ¾¾Ý¿Í»§µÄ¶ÔÒµÎñµÄÒªÇó £¬½øÐÐÓйØÒµÎñ½Ó¿ÚµÄËÑË÷ɸÑ¡   £»


b)½Ó¿ÚÍÆ¼ö£º¶Ô¹Ì¶¨ÖÜÆÚÁìÓòÄÚ£¨Ò»ÖÜ»òÒ»¸öÔ£©Ð°䲼µÄ½Ó¿Ú´ÍÓëÌáÐÑ £¬ÍƼöä¯ÀÀAPIÉ̵êµÄÓû§Ê¹Óà   £»


c)¶©ÔĽӿڣºËùÓÐÔڰ䲼״̬ϵÄAPI½Ó»°±úÏÖ¶©ÔÄ»ò½â³ý¶©ÔĵÄË«Ïò²Ù×÷ £¬¶ÔÒѶ©ÔĵĽӿڿɽâ³ý¶©ÔÄ   £»


d)¶©ÔÄĿ¼£º²é¿´µ±Ç°Òѱ»¶©ÔĵÄAPI½Ó¿ÚÌõ¿î £¬Í¨¹ýɸѡǰÌá²éÎÊÒѶ©ÔĵÄAPI½Ó¿Ú   £»


e)×ÊÁϲéÔÄ£ºÌṩAPI½Ó¿ÚµÄÓйØ×ÊÁϲéÔÄ £¬»ñÈ¡API½Ó¿ÚµÄʹÓü°½éÉÜÐÅÏ¢   £»


f)ÔÚÏßÊÔÓãºÔÚÉ̵êÖгöÏֵķþÎñÌṩ·½µÄAPI¾ß±¸ÔÚÏßÊÔÓòâÊÔµÄÄÜÁ¦ £¬ÊìϤAPI½Ó¿ÚµÄʹÓÃÒªÇó   £»


g)·þÎñÆÀ¼Û£ºÊ¢¿ª¶ÔAPI·þÎñʹÓõÄÐĵû¥»» £¬¶ÔAPI·þÎñµÄÆÀ¼Û×ÛºÏÆÀ¼Û £¬Æ¾¾ÝÆÀ¶¨´ò·ÖʵÏÖ×ۺϿ¼ÆÀAPI·þÎñÖÊÁ¿¡£



PART.3
APIÍø¹Ø

ͼƬ
ͼƬ

APIÍø¹ØÒËÓÐÒÔÏÂÖ°ÄÜ£º

a)Êý¾Ý´«Ê䣺¾ß±¸Êý¾Ý´«ÊäʵÏÖAPI·þÎñÐÅÏ¢»¥»»µÄÄÜÁ¦   £»


b)·þÎñ·ÓÉ£º¶ÔAPI·þÎñÌáÒéŲÓÃÒªÇó £¬²¢Æ¾¾Ý¶©ÔĵÄAPI·þÎñ £¬×Ô¶¯Ñ°Ö·ÕÒµ½API·þÎñÌṩ·½ £¬Í¨¹ý´úÀíµÄ·½Ê½Å²ÓÃAPI·þÎñ   £»


c)·þÎñ±àÅÅ£ºÊµÏÖ·þÎñµÄÍÏקʽ±àÅÅ¡¢Ìṩ¿ÉÊÓ»¯µÄ¹¤×÷Á÷±àÅÅÄÜÁ¦   £»


d)¹æ¶¨Å²ÓãºÀûÓÃÖнéÐÂÎÅÁ÷µÄÄÜÁ¦ £¬¶Ô·þÎñŲÓõÄÊý¾Ý½øÐж¨Ô컯´¦Öà   £»


e)ÈÏÖ¤ÊÚȨ£ºÊµÏÖÒªÇó·½API·þÎñµÄŲÓýÚÔì £¬Õƹܲ鳭API·þÎñµÄŲÓÃÈÏÖ¤   £»


f)·þÎñÈÛ¶Ï£ºÆ¾¾ÝÑ¡ÔñµÄAPIÈ۶ϼ¶±ð £¬¶ÔAPI·þÎñÔÚ¹¦·òÁìÓòÄÚÒ»Ñù·þÎñŲÓôÎÊýÏÞ¶ÈÄÜÁ¦ £¬³¬³öÈÛ¶Ï´ÎÊý½«Ê§È¥Å²ÓÃÄÜÁ¦   £»


g)Á÷Á¿½ÚÔ죺¾ß±¸½Ó¼ûÁ÷Á¿ÍÆËã £¬»ùÓÚÁ÷Á¿ÍÆËã·ÖÎö½øÐÐÏÞÁ÷ £¬½ç˵¶àÖÖÏÞÁ÷¹æ¶¨   £»


h)ÊÇ·ÇÃûµ¥£ºÊµÏÖ·þÎñÆ÷Ö®¼äµÄ»¥½Ó¼ûÏÞ¶È £¬Í¨¹ýÊÇ·ÇÃûµ¥×¢²á½Ó¼ûÊܿطþÎñÆ÷ £¬Ö´Ðв¢½âÎöÊÇ·ÇÃûµ¥Ï޶ȽӼû¡£


ͼƬ

¡ø ºÍ̸·Ö²ãת»»»¥ÁªÄ£ÐÍ


PART.4
API¼à¿Ø

ͼƬ
ͼƬ

API¼à¿ØÒËÓÐÒÔÏÂÖ°ÄÜ£º

a)»úÄÜ¼à¿Ø£ºÊµÏÖ·þÎñÆ÷ÔÚÔËÐÐ״̬ϸ÷ÀàÓ²¼þ×ÊÔ´£¨CPU¡¢ÄÚ´æ¡¢´æ´¢¡¢´ø¿í£©µÄ¼à¿Ø £¬¶Ôÿ´ÎŲÓÃAPI·þÎñÒªÇóÏìÓ¦µÄ»úÄܽøÐÐʱ³¤¼à¿Ø   £»


b)Òì³£¸æ¾¯£º¶ÔAPI·þÎñÔÚŲÓùý³ÌÖгöÏÖµÄÒì³£½øÐи澯ÊÂÎñ֪ͨ £¬Í³¼ÆAPI·þÎñ¸æ¾¯ÊÂÎñµÄÌõ¿î   £»


c)ÈÕÖ¾·ÖÎö£º¾ß±¸¼Í¼ÿ´ÎŲÓÃAPI·þÎñÒªÇóÏìÓ¦ÄÜÁ¦ £¬½«²Ù×÷Á÷Ë®¼Í¼ÐÅϢдÈëÈÕÖ¾ÎļþÖеÄÖ°ÄÜ   £»


d)ÒÀÀµ¹ØÏµ·ÖÎö£º¾ß±¸API·þÎñ¼äµÄ²ã¼¶¡¢Á£¶È £¬Ï໥¼äŲÓùØÏµµÄÒÀÀµ¹ØÏµÍ¼Æ×»ã×ÜÄÜÁ¦   £»


e)½Ó¿Úͳ¼Æ£º¶ÔÒѽÓÈëµÄAPI·þÎñÔÚ¶àÖÖ״̬ϵÄÊýÁ¿Í³¼Æ   £»


f)ʹÓôÎÊý£º¶ÔÒÑʹÓùýµÄAPI·þÎñ £¬ÔÚÿ´ÎŲÓÃÇé¿öÏ £¬»ã×ÜʹÓÃAPI·þÎñ´ÎÊýÄÜÁ¦¡£



¡¾ÍøÕ¾µØÍ¼¡¿