ÔÆ¶¥¼¯ÍŹÙÍø

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
°²È«¹ÜÀí

ͼƬ

¹ÜÀíËùÓзþÎñÇëÇ󷽵ݲȫµ÷ÓÃÐÐΪ £¬°²È«ÒÔ¼°·ÃÎÊÁîÅÆÏà¹ØµÄ²Ù×÷¡£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·þÎñ´ÎÊýÄÜÁ¦¡£



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