API Reference¶
Welcome to the Megamify™ Developer Guide. Here you will find reference material and gain insight into how our APIs work. Each API reference is broken down into several different sections.
Request Body¶
The request body is the object model that is sent as (JSON) to our API service. These models will contain properties that need to be sent along with your API as the payload. Some properties will be flagged as required, while others are optional.
Responses¶
The API service will either return a 200 OK or 201 Created with a JSON payload that can be deserialized as a model.
If the response fails for any reason, a 4XX or 5XX code is received. This could mean the API service is returning information about a bad request. Often, this could be missing parameters in your API call or a number of other reasons. The response contains valuable information about the error including error codes, error details and error messages from the server.
Success¶
| Name | Type | Description |
|---|---|---|
| code | int | HTTP status code |
| status | string | HTTP status |
| data | object | The data object (can be null) |
Error¶
| Name | Type | Description |
|---|---|---|
| code | int | HTTP status code |
| status | string | HTTP status |
| errors | object | The error object (can be null) |
Security¶
All API calls have some form of security that needs to be passed in the headers. Almost all calls will require at least the following:
| Name | Type | Description |
|---|---|---|
| Authorization | string | The JWT token (eg - JWT TOKEN_VALUE) |
Model Definitions¶
Each response from the API service can contain one or more Models in the response. You can also visit the Model Definitions section to see a list of Models supported by the API.
Event Model Definitions¶
Each event type has a set of properties that are included as part of event’s data wherever it is sent. The Event Model reference contains the models of the automatically generated event types.