{"id":11933,"date":"2019-10-22T15:04:50","date_gmt":"2019-10-22T06:04:50","guid":{"rendered":"https:\/\/www.eformsign.com\/kr\/support\/?post_type=manual_documentation&p=11933"},"modified":"2020-06-08T09:47:03","modified_gmt":"2020-06-08T00:47:03","slug":"access-token-issuance","status":"publish","type":"manual_documentation","link":"https:\/\/www.eformsign.com\/en\/support\/documentation\/open-api\/access-token-issuance\/","title":{"rendered":"2.3.1 OPA_001 API Key Access Token Issuance"},"content":{"rendered":"\n

API which issues Access Token with an API Key<\/p>\n\n\n\n

Rest API<\/h2>\n\n\n\n
https:\/\/api.eformsign.com\/v1.0<\/span>\/api_auth\/access_token<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Example<\/p>\n\n\n\n

https:\/\/api.eformsign.com\/v1.0\/api_auth\/access_token<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Method<\/h2>\n\n\n\n

POST<\/p>\n\n\n\n

Request Header<\/h3>\n\n\n\n
Name<\/strong><\/td>Type<\/strong><\/td>Description<\/strong><\/td>Miscellaneous<\/strong><\/td><\/tr>
Content-Type<\/td>String<\/td>Content-Type<\/td>application\/json<\/td><\/tr>
eformsign_signature<\/td>String<\/td>Signature value of execution_time<\/td>Value which signed execution_time value with private key
(Refer 2.2 eformsign signature generation and verification<\/a>)<\/td><\/tr>
api_key<\/td>String<\/td>api_key<\/td>api key<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Request Body<\/h3>\n\n\n\n
Name<\/strong><\/td>Type<\/strong><\/td>Description<\/strong><\/td>Miscellaneous<\/strong><\/td><\/tr>
execution_time<\/td>long<\/td>API call time(current time)<\/td>Only valid on calls within +\/- 30 seconds from its server time<\/td><\/tr>
member_id <\/td> String <\/td>The ID of a member<\/td><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Response Header<\/h3>\n\n\n\n
Name<\/strong><\/td>Type<\/strong><\/td>Description<\/strong><\/td>Miscellaneous<\/strong><\/td><\/tr>
Content-Type<\/td>String<\/td>Content-Type<\/td>application\/json<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Success Response Body<\/h3>\n\n\n\n
Name<\/strong><\/td>Type<\/strong><\/td>Description<\/strong><\/td>Miscellaneous<\/strong><\/td><\/tr>
api_key<\/td>Object<\/td>API Key info<\/td>api Key info object (includes name, alias, company )<\/td><\/tr>
api_key.name<\/td>String<\/td>API Key name<\/td> <\/td><\/tr>
api_key.alias<\/td>String<\/td>API Key alias<\/td> <\/td><\/tr>
api_key.company<\/td>Object<\/td>API Key company info<\/td>Company info object (includes id, name, api_url)<\/td><\/tr>
company.id<\/td>String<\/td>Company id<\/td> <\/td><\/tr>
company.name<\/td>String<\/td>Company Name<\/td> <\/td><\/tr>
company.api_url<\/td>String<\/td>API URL of corresponding company service<\/td> <\/td><\/tr>
oauth_token<\/td>Object<\/td>Token info<\/td>Token Object (includes token_type, access_token, refresh_token, expires_in)<\/td><\/tr>
oauth_token.token_type<\/td>String<\/td>Token type<\/td>Fixed JWT<\/td><\/tr>
oauth_token.access_token<\/td>String<\/td>access token<\/td> <\/td><\/tr>
oauth_token.refresh_token<\/td>String<\/td>refresh token<\/td> <\/td><\/tr>
oauth_token.expires_in<\/td>int<\/td>Access token valid time (seconds)<\/td>Valid until (expires_in) time from access token issued moment.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Fail Response Body<\/h3>\n\n\n\n
Name<\/strong><\/td>Type<\/strong><\/td>Description<\/strong><\/td>Miscellaneous<\/strong><\/td><\/tr>
error<\/td>Object<\/td>Error details<\/td>Only appears when there is an error. Error object (includes code, message)<\/td><\/tr>
error.code<\/td>String<\/td>Error code<\/td> <\/td><\/tr>
error.message<\/td>String<\/td>Error message<\/td> <\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Example<\/h4>\n\n\n\n

Request<\/strong><\/p>\n\n\n\n

POST \/v1.0\/api_auth\/access_token HTTP\/1.1\n\nContent-Type : application\/json\n\neformsign_signature : 304502206b59b0af9a55c19e1216acf0be3b136c487808cd2f6daa7907dcf655554546ff022100ab25d35ef0acd3be42507b680e7abe7325f93a78f53d59ef330cd5fa528f3312\n\napi_key : 00a1ad0a-6e73-42fd-a4e4-4a1bf4c51f5a\n\nHOST : https:\/\/api.eformsign.com\n\n{\n\n\"execution_time\" : 1533011071001\n\n}<\/code><\/pre>\n\n\n\n
Response<\/strong><\/p>\n\n\n\n
– When succeeded<\/p>\n\n\n\n
HTTPS\/1.1 200 OK\nContent-Type: application\/json\n{\n\"api_key\": {\n\"name\": \"access key\",\n\"alias\": \"access Key alias\",\n\"company\": {\n\"company_id\": \"129jd93j29jd9j29jd\",\n\"name\": \"Forcs\",\n\"api_url\": \"https:\/\/kr-api.eformsign.com\"\n}\n},\n\"oauth_token\": {\n\"token_type\": \"JWT\",\n\"access_token\": \"eyJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJvY2UuaWFtIiwiY29udGV4dCI6eyJjbGllbnRJZCI6IjE5MzEyYWI2NWQxMTQ4NjY4ZDJiNjFjYjZjYzUwNTBmIiwiY2xpZW50S2V5IjoiZTliYTM1YjEtYjY5NS00YWMzLWIzMTMtYjZhNGQ1MzZiZDVkIiwibWFuYWdlbWVudElkIjoiNTRlMDgzNGJjODllNDM3MWE4MTM5ODUzZGNjNTQzMzciLCJzY29wZXMiOiJlZm9ybVNpZ25fc2NvcGUiLCJ0eXBlIjoidXNlciIsInVzZXJOYW1lIjoid2luZHk0Nzg4QGZvcmNzLmNvbSIsInVzZXJJZCI6ImFlYTkwYmI0NWMwNTQ1YTdiMjUxNjUwNWI1MmE0NjQyIiwicmVmcmVzaFRva2VuIjoiZGNhZjEzN2ItZTkzZS00MjA3LWJhOGEtMmRkNWExMjUwYzQ1In0sImNsYWltIjp7fSwiZXhwIjoxNTYwMTYwMDg1LCJpYXQiOjE1NjAxNTY0ODV9.GdULyCkZkCTl3KkwfnK16Ls8XPPGL9AqoWTcYj9R9gRh7nHYSRoPh42K3_uxPvzy3b6y5AvF_VKbppMEAxA6prJNidWb1dZhSy5DR0nd92E6inaeUeSGjt7fJDUhj91PHiKZCk8WsAwaLpEWIjy4NG3IDdyvXYntCm_0MbLdV-o\",\n\"refresh_token\": \"dcaf137b-e93e-4207-ba8a-2dd5a1250c45\",\n\"expires_in\": 3600\n}\n}<\/code><\/pre>\n\n\n\n
– When failed (error)<\/p>\n\n\n\n
HTTPS \/ 1.1 403 forbidden\nContent-Type: application\/json\n{\n\"error\": {\n\"code\": \"4030001\",\n\"message\": \"invalid api key\"\n}\n}<\/code><\/pre>\n","protected":false},"author":1,"featured_media":0,"parent":11930,"menu_order":0,"template":"","manualdocumentationcategory":[44],"_links":{"self":[{"href":"https:\/\/www.eformsign.com\/en\/support\/wp-json\/wp\/v2\/manual_documentation\/11933"}],"collection":[{"href":"https:\/\/www.eformsign.com\/en\/support\/wp-json\/wp\/v2\/manual_documentation"}],"about":[{"href":"https:\/\/www.eformsign.com\/en\/support\/wp-json\/wp\/v2\/types\/manual_documentation"}],"author":[{"embeddable":true,"href":"https:\/\/www.eformsign.com\/en\/support\/wp-json\/wp\/v2\/users\/1"}],"version-history":[{"count":2,"href":"https:\/\/www.eformsign.com\/en\/support\/wp-json\/wp\/v2\/manual_documentation\/11933\/revisions"}],"predecessor-version":[{"id":13480,"href":"https:\/\/www.eformsign.com\/en\/support\/wp-json\/wp\/v2\/manual_documentation\/11933\/revisions\/13480"}],"up":[{"embeddable":true,"href":"https:\/\/www.eformsign.com\/en\/support\/wp-json\/wp\/v2\/manual_documentation\/11930"}],"wp:attachment":[{"href":"https:\/\/www.eformsign.com\/en\/support\/wp-json\/wp\/v2\/media?parent=11933"}],"wp:term":[{"taxonomy":"manualdocumentationcategory","embeddable":true,"href":"https:\/\/www.eformsign.com\/en\/support\/wp-json\/wp\/v2\/manualdocumentationcategory?post=11933"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}