Search in documentation
ctrl+4K
First steps
Homologation
About our APIs
First steps

Create an application

The portal automatically creates a test application when you register. Use this application to test the API. To see the test application credentials, log in and click My apps.
Production application
Create a production application only after homologating the test application.
After finishing development and testing, create a production application.
  1. Click on the Apps > New Application menu.
  2. Choose the application type according to your distribution model:• Centralized (SaaS) - Software available in the cloud with access to all stores in a centralized instance• Distributed (On-premises) - Software installed in the store environment with restricted access to that store
  3. Fill in the mandatory data: name, description and URL.
  4. Select the API modules that your application will access.
  5. Define if the application will be listed for all partners or exclusive to specific customers.
The system automatically generates access credentials after registration. Homologate the application before making it available to your customers.

Application registration best practices

Provide clear and accurate information to help users choose your application.
  • Application name: Choose a unique, memorable name that reflects functionality. Avoid generic or long names.
  • Application URL: Provide the official website URL. Keep the site updated with relevant information.
  • Description: Write a slogan that describes your application. Be catchy and quickly convey its function.
  • Full description: Explain how the application works, what problems it solves and why users should choose it.
  • Category: Select the category that best describes your application to facilitate discovery in the marketplace.
  • Visibility: Define if the application will be public (visible in the marketplace) or private.
  • Logo: Upload a clear, attractive, high-quality image. Avoid text in the image.
  • Image gallery: Include screenshots of the main functionalities. Use clear, high-quality images that accurately represent the user experience. Avoid generic images.

Define the application category

After registration, set your application category. This choice affects:
  • Developer Portal registration
  • Test order generation
  • Approval process
  • Available API modules

Available types

  • Food: For integrations focused on food delivery.
  • Grocery: For integrations focused on grocery, pharmacy, pet shop and shopping.
Select your application category:

Food

APIs for food delivery.

Grocery

APIs for grocery, pharmacy, pet shop and shopping.
Was this page helpful?
Rate your experience in the new Developer portal:
On this page
Create an application
Application registration best practices
Define the application category
Available types
Content read0%