Welcome
=======

Welcome to the documentation for the MyParcel.com API and related software.

Credentials
-----------
To communicate with our API or to use our SDK, you need a valid ``client_id`` and ``client_secret``.
If you do not already possess these credentials, you should create them on the `API Clients page <https://app.myparcel.com/clients>`_ of our portal.

API
---
For everything from authentication to each feature and resource offered by our API, including step by step guides, read the :doc:`API chapter </api>` of these docs.

PHP SDK
-------
A quick way to start using our API is to implement :doc:`our PHP-SDK </php-sdk>` into your project using composer. With a few lines of code, you could be sending shipments using our platform.

Carrier integrations
--------------------
Our carrier library is expanding and it is possible to add a carrier to our library. You can develop the integration following :doc:`our programme </carrier-integration-programme>`, or contact us if you want us to integrate a specific carrier.

e-Commerce integrations
-----------------------
We have integrations with several e-commerce platforms. If you are missing your platform, you can develop the integration following :doc:`our programme </e-commerce-integration-programme>`, or contact us if you want us to integrate it.

.. toctree::
    :caption: Documentation
    :hidden:
    :maxdepth: 1

    api
    php-sdk
    carrier-integration-programme
    e-commerce-integration-programme
    development

.. toctree::
    :caption: Links
    :hidden:

    API specification <https://api-specification.myparcel.com>
    GitHub <https://github.com/MyParcelCOM>
    MyParcel.com <https://www.myparcel.com>
    Contact us <https://www.myparcel.com/contact>