Documentation

Create your app document(s) and view status whether they are approved or not.

You can edit a document by filling in the required information. Once admin approves your document, you do not have the option to delete it. Clicking on Update Document will add new information in your document.

It describes what should a developer include in a document while submitting an app:

  • What your app does and which actions are supported?

    Developers will define the description of their app and what it will do. They must specify the app methods they will be using. This is important to make sure that their RESTful API works efficiently with Enrich.io and meets its users expectations.

  • How to get started with your app?

    • Developers will provide authentication for their app. It can be Basic, NoAuth, Oauth2 or API key.

    • A list of errors is required.

    • Details of app actions and what they do.

    • Define app methods where input parameters will be defined. It must include details of Method Endpoint URL, Method Type and Method Payload.

  • Common issues you can face with your app (optional)

    These are the issues faced while integrating the app.

  • Popular things to do with your app

    Developers will define what their app does and how it will be beneficial to the end-user.

  1. Click on AppDocumentation tab in the left menu to view the existing documentation or to create a new documentation about your app. Click Create New Document to create a new documentation about your app.

  2. On the App Document page, provide details for your app i.e Name, Link, Type, APP Name, Description, and click Add Document.