🕴️ GETTING STARTED
This page will help you get started with Elixir. You'll be up and running in a jiffy!
Elixir offers a powerful REST API that supports tokenization in the bitcoin's sidechain of Liquid. It brings powerful features to create a unique NFT standard technology for inter-operable skins. You can download our RESTful API postman collection below.
Elixir dev.postman_collection.json
46KB
Code
ELIXIR POSTMAN COLLECTION
The easiest way to get started with our RESTful API is getting an
API Keyin dashboard.elixir.app. Just register on our site and then click on the settings section.You're going to need a username and a password the first time that you log in.
Elixir Developer Console - Creating an API key
Once on the settings section, you can issue an
API Key in the API Keys tab.We are developing different environments for production and testing.
Environment | Status | Access |
Sandbox | Ready | |
Production | Ready |
The Elixir API uses
API Keysto authenticate requests. You can view and manage your API Keys in the API keys section.Authentication to the API is performed with a key. Provide your API key on the
token header.All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API Requests without authentication will also fail.
Elixir uses conventional HTTP response codes to indicate the success or failure of an API request. Codes in the
2xxrange indicate success, in the 4xxrange indicate an error that failed given the information provided (usually a required parameter was omitted or incorrectly sent), in the 5xxrange indicate an error with Elixir servers.Status Code | Meaning | HTTP Response |
200 - OK | Everything worked as expected | { data: { ... } } |
201 - OK | Entity created with success | { data: object } |
400 - Bad Request | The request was unacceptable, often due to an incorrect or missing required parameter. | { success: false, message: 'Error details' } |
404 - Not Found | The requested resource doesn't exist | { success: false, message: 'Error details' } |
500 - Server Errors | Something went wrong with Elixir's servers | { success: false, message: 'Error details' } |
Last modified 2mo ago