{"id":11937,"date":"2019-10-22T15:12:18","date_gmt":"2019-10-22T06:12:18","guid":{"rendered":"https:\/\/www.eformsign.com\/kr\/support\/?post_type=manual_documentation&p=11937"},"modified":"2019-11-27T10:15:12","modified_gmt":"2019-11-27T01:15:12","slug":"refresh-token","status":"publish","type":"manual_documentation","link":"https:\/\/www.eformsign.com\/en\/support\/documentation\/open-api\/refresh-token\/","title":{"rendered":"2.3.2 OPA_002 API Key Refresh Token"},"content":{"rendered":"\n

API which updates\/refreshes Access Token<\/p>\n\n\n\n

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

Example<\/p>\n\n\n\n
https:\/\/api.eformsign.com\/v1.0\/api_auth\/refresh_token<\/td><\/tr><\/tbody><\/table>\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>
access_token<\/td>String<\/td>access_Token issued from eformsign<\/td> <\/td><\/tr><\/tbody><\/table>\n\n\n\n

Request Body<\/h3>\n\n\n\n
Name<\/strong><\/td>Type<\/strong><\/td>Description<\/strong><\/td>Miscellaneous<\/strong><\/td><\/tr>
refresh_token<\/td>String<\/td>Refresh token<\/td>Refresh Token which to update Access Token<\/td><\/tr><\/tbody><\/table>\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>\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>
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>
api_key.company<\/td>String<\/td>refresh token<\/td> <\/td><\/tr>
company.id<\/td>int<\/td>Access token valid time (seconds)<\/td>Valid until (expires_in) time from access token issued moment.<\/td><\/tr><\/tbody><\/table>\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>\n\n\n\n

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

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

POST \/v1.0\/api_auth\/refresh_token HTTP\/1.1\n\nContent-Type : application\/json\n\nHOST : https:\/\/api.eformsign.com\n\n\n\naccess_token:eyJ3h2Gc1OiJSUzI1N2139.eyJpc3MiOiJvY2UaduaWFtIiw4AcWKsoF35VZCI6IjE5MzEyYWI2AWGSddfo4WDF-YzqHGtUHKCkKelu5JN2PSSv6ZI8 ... UxeMTmjx_97ip2bragIfP54SAD-VSERgsSP_sfefEXFG_asdFNK4f\n{\n\n\"refresh_token\" : \"dcaf137b-e93e-4207-ba8a-2dd5a1250c45\"\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\"oauth_token\": {\n\"token_type\": \"JWT\",\n\"access_token\": \"eyJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJvY2UuaWFtIiwiY29udGV4dCI6eyJjbGllbnRJZCI6IjE5MzEyYWI2NWQxMTQ4NjY4ZDJiNjFjYjZjYzUwNTBmIiwiY2x-PtUZnqHGtUHKCkKelu5JN2PSSv6ZI8 ... UxeMTmjx_97ip2bragIfPaOd70V1qHY1SP_IFTLLlnzd_PUIwiPS0\",\n\"refresh_token\": \"03a54d50-f0a2-4db6-9f1a-02b3e6d9a68f\",\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\/11937"}],"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":1,"href":"https:\/\/www.eformsign.com\/en\/support\/wp-json\/wp\/v2\/manual_documentation\/11937\/revisions"}],"predecessor-version":[{"id":12718,"href":"https:\/\/www.eformsign.com\/en\/support\/wp-json\/wp\/v2\/manual_documentation\/11937\/revisions\/12718"}],"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=11937"}],"wp:term":[{"taxonomy":"manualdocumentationcategory","embeddable":true,"href":"https:\/\/www.eformsign.com\/en\/support\/wp-json\/wp\/v2\/manualdocumentationcategory?post=11937"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}