Welcome to the quick guide of SWORD API
Sword’s API is composed by two endpoints: The first one helps us to get the anomaly of any device based on the input characteristics (UserAgent - Fingerprint - IP - Cookie).
The second one is used for add a device in case it doesn’t exist and if its trusted.
ℹ️All requests must include a Header named Authorization, followed by an HTTP authorization string of type Basic, for example:
For user user
with password password
, a Base64 text string must be generated from user:password
, preceded by the term Basic
and a blank space. Thus, the resulting authorization string would be: Basic dXNlcjpwYXNzd29yZA==
.
The API Credentials are provided on Masiv configuration page and managed by platform team.
List of the possible HTTP/S response codes that can be generated by the system.
Code | Name | Description |
---|---|---|
200 | OK | The request succeeded. |
400 | Bad Request | The server cannot or will not process the request due to something that is perceived to be a client error (Usually when the request body do not include required parameters) |
500 | Internal Server Error | The service has encountered a situation it does not know how to handle |
Sword Orchestrator base URL:
<aside> 🔗 **https://api-sword-service.masivapp.com/v1**
</aside>
Sword Orchestrator API its on V1.