> For the complete documentation index, see [llms.txt](https://docs.shiptify.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.shiptify.com/general-overview/introduction/before-you-start.md).

# Before you start

### Requirements – Technical skills

Technically speaking, SHIPTIFY APIs are a set of Operations accessible by a standardized web protocol. Each operation can be called by a client application to request shipment information or even book a shipment. Client applications will request a certain operation to be executed with the application specific request data. SHIPTIFY API then responds synchronously by sending back response data in a standard pre-defined format. The client application can then process the response data to complete the subsequent workflow.

{% hint style="info" %}
In order to access the web service RESTful Services are used and developers should be familiar with JSON and have a basic understanding of web services.
{% endhint %}

### Requirements – Business understanding

Developers who plan to connect their tools or services to SHIPTIFY APIs should also have a closer look into SHIPTIFY’s products and services. More details about our products and services are available at [www.shiptify.com](https://docs.shiptify.com/general-overview/introduction/www.shiptify.com) and your SHIPTIFY Sales representative.

### Requirements – API Key

{% hint style="info" %}
Before you start using our REST API services, you will need to obtain your <mark style="color:purple;">API key</mark> with your SHIPTIFY sales representative. <mark style="color:purple;">Api-key</mark> is persistant and has no time limit.
{% endhint %}

### Access conditions

Shiptify reserves the right to terminate services if we detect any abuse on API Key. Shiptify reserves the right to modify services design and specifications.

### Limit

Be nice. If you’re sending too many requests too quickly, we’ll send back an error code (TooManyRequests). You are limited to 10 reqs / sec per account.

If you want to plan performance tests, please be in touch with our team before at [api@shiptify.com](mailto:api%40shiptify.com).

### What can I do with API?

The Shiptify Platform was created to bring together all stakeholders of the supply chain in one intuitive UI.

The Shiptify API is designed:

* to allow input of external generated data inside Shiptify Platform.
* but also to retrieve generated data from Shiptify Platform.

All actions related to interactions between people are exclusively set through our UI (Shipitfy Platform) and not via the API. Therefore, all actions linked to internal workflows are not possible (Per instance: change status of a shipment).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.shiptify.com/general-overview/introduction/before-you-start.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.