UG»·Çò¹ÙÍø

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·þÎñ´ÎÊýÄÜÁ¦¡£¡£



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