Skip to content
English
  • There are no suggestions because the search field is empty.

How to work with the Poster API: answers to frequently asked questions

In this article, we’ve collected answers to common questions about the Poster API, developer accounts, creating and publishing integrations, authorization, webhooks, and the POS and Device platforms.


Go to the section you need to find your answer:


 

General questions

What is a developer account and why do I need it?

A developer account is a special Poster account that includes:

  • A test environment, which has all the features of a regular Poster client account.
  • Tools for app development, which you use to create integrations for later publication in the Poster Applications Catalog.

You can register a developer account in one of two ways, following this guide.

☝️ A separate developer account is required if you plan to publish an integration in the Poster Applications Catalog.

💡 If you are building an integration for your own needs or for one specific client, for example to connect Poster to a personal website, a personal integration token from a client account is enough.


Do I have to pay for a developer account?

No, the developer account is free.

Right after registration, the account is automatically extended for 15 days. When this period ends, write to the support chat and ask to extend your developer account.


How do I link a developer account to a Poster client account?

You don’t need to link them. The developer account is a separate account where you create and configure your integration.

When the integration is ready, the client connects it to their account via a direct link or through the Poster Applications Catalog, if the integration has been published.

💡 The interaction happens not between the accounts but between the developer’s application and the client’s account, through API requests. To determine which account a request belongs to, an access token is used.


Can I add custom functionality to Poster QR using the API?

No. Poster QR does not have its own API, so you can’t interact with it directly through an integration.

However, most menu-related settings are available through the Poster Web API.


Marketplace and publishing integrations

Where can I find a specific integration?

All available integrations are collected in the Poster Applications Catalog.

If you can’t find the application you need, contact a third-party developer. They can help you build an integration with the required functionality based on the open Poster API.


Do I have to publish my application in the Poster Applications Catalog?

No. You can keep your application out of the catalog and give access only to your own clients.

To connect the integration, send your clients a direct link in this format:

https://joinposter.com/applications/Your-Integration-Name


Can I sell my integration through Poster?

Yes. You can list your integration in the Poster Applications Catalog so that other Poster users can find and connect it.

To do this, prepare the application’s name and marketing description, add images, and submit it for review. You will also need to present the integration to our manager.

Once published, the integration becomes available to Poster users in 23,000 locations across 122 countries. You can attract new customers and sell your product through Poster, and the built-in billing system simplifies collecting payments for the integration.


How long does the review of an integration in the Poster Applications Catalog take?

The review takes up to 14 days.
💡 A repeat review after changes also takes up to 14 days.

To speed up the review and avoid unnecessary delays:

  • Test your application before submitting it for review. Make sure it works correctly in all intended user scenarios.
  • Provide test access to your service, or let us know if this isn’t possible.
  • Record a video tutorial on connecting and using the integration. It will also help future users get up to speed faster.
  • Name the Poster clients who are already testing your application.
  • Fill in the marketing description, add user instructions, and specify prices for each region.


Do I need to resubmit my integration for review after changes to the POS platform or application code?

No. If you change the application code or its POS platform, a repeat review is not required.

To apply changes to the POS platform, run the command: npm run deploy


When will the changes appear for the client after deployment?

After deployment, the client needs to reload the Poster app twice. After that, the changes will become available.

Do I need to resubmit my integration for review after changing its settings?

Yes, a repeat review is required if you change any of the following:

  • the marketing description;
  • the webhook URL;
  • the OAuth URL;
  • the Manage URL;
  • API access permissions.

Submit the integration for another review so we can check the updated data and publish the changes.


Authorization and access

Where do I get a token if I don’t need a separate application?

Register a Poster account and open the admin panel. Go to Access → Integrations → Personal integration and copy the key.

A personal integration token works if you are building an integration for one client, for example to connect your own website to Poster.

☝️ If different clients will use the integration, set up OAuth authorization. It lets you obtain a separate access token for each client account.


How do I set up OAuth authorization?

Follow the written instructions for setting up OAuth.


How long is an access token valid?

An access token is valid for 2 years from the date of issue.


What should I do if my token has expired?

If your token has expired, reconnect the integration and complete OAuth authorization again. You will then receive a new token, valid for another 2 years.

Support staff can reissue a personal integration token for you. To request this, write to us in the chat.


Web API

Why does the Web API return an error for my request?

Check the code and message parameters in the error response.

The message parameter contains a brief description of the cause of the error. The list of error codes is provided on the Web API documentation page.


How do I integrate a Tilda, OpenCart, Wix, WordPress, uKit, or custom-built website with Poster so I can receive online orders?

To integrate your website with Poster, contact a third-party developer. They can help you set up the transfer of online orders using the Poster API.

We have also prepared documentation on integrating online stores with Poster.

For WordPress + WooCommerce websites, there is a ready-made integration in our applications catalog.


Can I transfer product, technical card, or category images through the API?

No. The Poster API does not support transferring images for products, technical cards, or categories.

Upload photos directly in the Poster admin panel, in the Menu section.


How do I verify a phone number before creating an online order or a customer card?

To check the phone number format before sending an API request and avoid errors caused by incorrect data, use the libphonenumber library.


Webhooks

Can I use webhooks without creating an application?

No. To receive webhooks from Poster, create an application in your developer account and set up a webhook URL for it.


Why am I not receiving webhooks?

If you are not receiving webhooks, check the following settings:

  1. Webhook URL. Make sure your server accepts POST requests and returns a response with status 200.
  2. Application settings. Check that the webhook URL is entered correctly. After you click Check, a green checkmark should appear.
  3. Webhook subscriptions. Make sure you have subscribed to webhooks for the required entities in the application settings.
  4. Webhook sending. Try simulating a webhook: in the Poster admin panel, change the entity you expect a notification for.
  5. Integration connection. Check that the application is connected to the account from which you expect webhooks.
  6. Application publication. If the application is already published in theApplications Catalog, wait until the repeat review is complete.
    💡 Changes to settings take effect only after we approve them on our side.

POS platform

Why is there no Dev/Prod switch on the register?

To make the Dev/Prod switch appear on the register:

  1. Turn on the POS platform toggle in your application’s settings.
  2. In your developer account, add the Poster account whose register you want to test the integration on to the developers list.
  3. Connect the integration to this Poster account through the Poster Applications Catalog.


Can I send JavaScript CORS requests through the browser?

No, such requests are blocked. To send requests, use third-party tools, for example Postman.


Can I add two or more application buttons in the POS platform?

No. Only one button per application is allowed in the POS platform.


Can I add additional information to the receipt?

Yes. To add text to the printout, use the orders.setPrintText method.

The orders.printReceipt method lets you print a pre-receipt with a QR code and additional text.


Device platform

Is there an emulator for a thermal printer and a fiscal register?

There is no full-featured emulator for a thermal printer or a fiscal register.

If you only need to receive raw bytes, run a local printer server on port 9100.


If you didn’t find the answer to your question or need additional help, write to us in the chat.