Api

Introduction

A brief introduction to the API documentation.

The MarkupGo API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Base URL

The base URL for the MarkupGo API is https://api.markupgo.com/api/v1. All endpoints are relative to this base URL.

Authentication

The MarkupGo API uses API keys to authenticate requests. You can view and manage your API keys in the MarkupGo dashboard.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. You need to include your API key in the x-api-key header of each request.

Headers
"x-api-key": "YOUR_API_KEY"

Errors

MarkupGo uses conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted), and codes in the 5xx range indicate an error with MarkupGo's servers.

Resources