What is Authenticate
The Authenticate endpoint is used to verify your API ID and API Key and returns a token which will expire in 30 minutes for use with the OpenPath server resources.
How Authentication Works
In order to access any of the OpenPath API server resources you must first request a token from the authenticate endpoint by sending you API ID and API key, which can be created in the settings of the OpenPath Client Application.
Once successfully authenticated you will receive an authorization token that can be used in subsequent requests to server resources. In all subsequent requests be sure to include Authorization: bearer {AUTHORIZATION TOKEN} in your header requests.
Once successfully authenticated you will receive an authorization token that can be used in subsequent requests to server resources. In all subsequent requests be sure to include Authorization: bearer {AUTHORIZATION TOKEN} in your header requests.
Endpoints
POST https://api-app.openpath.io/v1/authenticate
Authenticates an API ID and API Key with a Security Token.
Authenticate Initial Request
POST /v1/authenticate HTTP/1.1
Host: api-app.openpath.io
Content-Type: application/x-www-form-urlencoded
Cache-Control: no-cache
apiid={YOUR API ID}&apikey={YOUR API KEY}
Authenticated Subsequent Requests
GET /v1/{SERVER RESOURCE} HTTP/1.1
Host: api-app.openpath.io
Authorization: bearer {TOKEN}
Content-Type: application/json
Cache-Control: no-cache
Authenticate Result
"result": {
"authentication_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIzR3Y5N2dFTWRrYXhVVXNoNDVQZnNhN3NuZnlIcnd6UyIsImp0aSI6ImE1NWVjNmU0LTQ4Y2QtNDhiMy1iODA2LTYyYTc1ZjMwM2Q2NiIsImlhdCI6MTQ3MjUwMzIzOCwiYXBpX2lkIjoiMSIsIm9yZ2FuaXphdGlvbl9pZCI6IjE1IiwibmJmIjoxNDcyNTAzMjM4LCJleHAiOjE0NzI1MDUwMzgsImlzcyI6Imh0dHBzOi8vYXBpLWFwcC5vcGVucGF0aC5pbyIsImF1ZCI6IkFwaUlkIn0.OuElGnKPVocxz-xL94EQFONbhKRNe9BUQugGKQ5jBb0",
"expires_in_seconds": 300
}
Definitions
Authenticates an API ID and API Key with a Security Token.
Authenticate Initial Request
POST /v1/authenticate HTTP/1.1
Host: api-app.openpath.io
Content-Type: application/x-www-form-urlencoded
Cache-Control: no-cache
apiid={YOUR API ID}&apikey={YOUR API KEY}
Authenticated Subsequent Requests
GET /v1/{SERVER RESOURCE} HTTP/1.1
Host: api-app.openpath.io
Authorization: bearer {TOKEN}
Content-Type: application/json
Cache-Control: no-cache
Authenticate Result
"result": {
"authentication_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIzR3Y5N2dFTWRrYXhVVXNoNDVQZnNhN3NuZnlIcnd6UyIsImp0aSI6ImE1NWVjNmU0LTQ4Y2QtNDhiMy1iODA2LTYyYTc1ZjMwM2Q2NiIsImlhdCI6MTQ3MjUwMzIzOCwiYXBpX2lkIjoiMSIsIm9yZ2FuaXphdGlvbl9pZCI6IjE1IiwibmJmIjoxNDcyNTAzMjM4LCJleHAiOjE0NzI1MDUwMzgsImlzcyI6Imh0dHBzOi8vYXBpLWFwcC5vcGVucGF0aC5pbyIsImF1ZCI6IkFwaUlkIn0.OuElGnKPVocxz-xL94EQFONbhKRNe9BUQugGKQ5jBb0",
"expires_in_seconds": 300
}
Definitions
| Name | Field | Data Type | Description |
|---|---|---|---|
| Authentication Token | authentication_token | text | 30 Minute security token used for requests to server resources |
| Expires in Seconds | expires_in_seconds | number | Life of the security token in seconds |