API: Authenticating
This document provides a guide for software developers to use the Archiver REST API.
The first REST API request you need to make is to authenticate your email and password. Upon successful authentication, an authorization token is returned which your client must use for any subsequent requests. The authorization token is valid for 2 hours, and it should be reused for subsequent request for at least 1 hour.
Service URL:
post | /api/v1/login |
---|
The service URL will depend on whether your Archiver account is hosted within the US or EU. Please ask your Sageflo Account Manager if you are not sure which to use.
Request Method:
Post
HTTP Headers:
Content-Type: application/json
Request JSON:
{ "email": "<LOGIN_EMAIL>", "password": "<PASSWORD>" }
HTTP Status Code:
The API will return a status code of 200 for a successful request and 401 for a failed authentication.
Response JSON:
{ "auth_token": "<AUTH_TOKEN>", "issued_at": "<TIMESTAMP>" }