{"id":3439,"date":"2018-03-04T11:09:16","date_gmt":"2018-03-04T09:09:16","guid":{"rendered":"http:\/\/modulus.help\/kb\/docs\/modulus-api\/introduction\/step-2-authentication-token\/"},"modified":"2025-11-17T12:07:57","modified_gmt":"2025-11-17T10:07:57","slug":"step-2-authentication-token","status":"publish","type":"docs","link":"https:\/\/modulus.help\/kb\/docs\/documentation\/getting-started\/step-2-authentication-token\/","title":{"rendered":"Authentication Token"},"content":{"rendered":"

In order to make API calls, you need first to create an authentication token. The token is a hashed key that is required in every modulus® API call.<\/p>\n

Request<\/h4>\n\n\n\n\n\n\n\n\n
API Name<\/th>\nAuthenticate<\/td>\n<\/tr>\n
URL<\/th>\nhttps:\/\/your_account.modulus.biz\/api\/cmn\/Authenticate<\/td>\n<\/tr>\n
Method<\/th>\nPost<\/td>\n<\/tr>\n
Source<\/th>\nThird Party Server<\/td>\n<\/tr>\n
Recipient<\/th>\nmodulus® Server<\/td>\n<\/tr>\n
Content Type<\/th>\napplication\/x-www-form-urlencoded<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Request Body Parameters<\/h4>\n\n\n\n\n\n\n
Parameter<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
app<\/th>\nName of your application as provided by modulus® team.<\/td>\n<\/tr>\n
secret<\/th>\nApp secret as provided by modulus® team.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Responses<\/h4>\n\n\n\n\n\n\n\n\n\n
HTTP Status<\/th>\nresult<\/th>\ntitle<\/th>\nmessage<\/th>\nobject<\/th>\n<\/tr>\n<\/thead>\n
Success Responses<\/th>\n<\/tr>\n
200 OK<\/td>\ntrue<\/td>\nSuccess<\/td>\nAuthentication succeeded.<\/td>\n\n
{\r\n    \"token\": \"YOUR_TOKEN\",\r\n    \"app_id\": \"YOUR_APP_ID\",\r\n    \"ip\": \"AUTHENTICATED_IP_ADDRESS\"\r\n}<\/code><\/pre>\n<\/td>\n<\/tr>\n
Failure Responses<\/th>\n<\/tr>\n
400 Bad Request<\/td>\nfalse<\/td>\nBad Request<\/td>\nMissing one or more of parameters account, app, secret.<\/td>\nnull<\/td>\n<\/tr>\n
401 Unauthorized<\/td>\nfalse<\/td>\nUnauthorized<\/td>\nAuthentication failed.<\/td>\nnull<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Please note that authentication token expires 15 minutes after creation.<\/p>\n

Example<\/h4>\n\n\n\n\n\n\n\n\n
Request<\/th>\n\n
curl --request POST 'https:\/\/your_account.modulus.biz\/api\/cmn\/Authenticate' \\\r\n--header 'Content-Type: application\/x-www-form-urlencoded' \\\r\n--data-urlencode 'app=YOUR_APP_NAME' \\\r\n--data-urlencode 'secret=SECRET_KEY'\r\n<\/code><\/pre>\n<\/td>\n<\/tr>\n
Success Responses<\/th>\n<\/tr>\n
200 OK<\/th>\n\n
{\r\n    \"result\": true,\r\n    \"title\": \"Success\",\r\n    \"message\": \"Authentication succeeded.\",\r\n    \"object\": {\r\n        \"token\": \"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\r\n        \"app_id\": \"XXX\",\r\n        \"ip\": \"X.X.X.X\"\r\n    }\r\n}<\/code><\/pre>\n<\/td>\n<\/tr>\n
Failure Responses<\/th>\n<\/tr>\n
400 Bad Request<\/th>\n\n
{\r\n    \"result\": false,\r\n    \"title\": \"Bad Request\",\r\n    \"message\": \"Missing one or more of parameters account, app, secret.\",\r\n    \"object\": null\r\n}<\/code><\/pre>\n<\/td>\n<\/tr>\n
401 Unauthorized<\/th>\n\n
{\r\n    \"result\": false,\r\n    \"title\": \"Unauthorized\",\r\n    \"message\": \"Authentication failed.\",\r\n    \"object\": null\r\n}<\/code><\/pre>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n","protected":false},"featured_media":0,"parent":3432,"menu_order":1,"comment_status":"closed","ping_status":"closed","template":"","doc_tag":[],"comment_count":0,"_links":{"self":[{"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/docs\/3439"}],"collection":[{"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/types\/docs"}],"replies":[{"embeddable":true,"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/comments?post=3439"}],"version-history":[{"count":27,"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/docs\/3439\/revisions"}],"predecessor-version":[{"id":4541,"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/docs\/3439\/revisions\/4541"}],"up":[{"embeddable":true,"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/docs\/3432"}],"next":[{"title":"Authentication JWT Token","link":"https:\/\/modulus.help\/kb\/docs\/documentation\/getting-started\/authentication-jwt-token\/","href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/docs\/4587"}],"prev":[{"title":"Create App","link":"https:\/\/modulus.help\/kb\/docs\/documentation\/getting-started\/step-1-create-app\/","href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/docs\/3438"}],"wp:attachment":[{"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/media?parent=3439"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/doc_tag?post=3439"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}