Skip to main content

Quick Start

API Onboarding Process

For each API you want to publish on myAPIz platform, we have a list of basic requirements that the API and provider need to implement.

RESTful APIs​

  • API endpoints need to be working and publicly available
  • API needs to provide Open API 3.x compatible JSON document as URL
  • API provider needs to provide a configuration file as defined in the configuration reference
  • API should be ready to handle the headers as defined in your configuration file
  • login to myAPIz and create an organisation under which the API will be published
  • you need to submit the following as an email to hello@myapiz.com and wait for our confirmation (usually within 2 working days).
    • the configuration file for the API being published
    • email used to login to myAPIz
    • organisation name, if created Note that this manual process is being currently automated.