What authentication does the Boomerangme API use?

Boomerangme uses an API key passed in the x-access-token request header. When you call it through Jentic, the access token is stored in your Jentic One instance and injected at execution time, so the raw token never enters the agent's context.

Can I issue an Apple Wallet pass with the Boomerangme API?

Yes. Call POST /createPass with a clientId and a templateId; Boomerangme returns a wallet pass URL that works in both Apple Wallet and Google Pay. The customer adds the pass with one tap from a browser or messaging app.

How do I look up a customer's loyalty passes by phone number?

Use POST /getClientPassesByPhone with the customer's phone in international format. The endpoint returns every active pass attached to that number, including the template, stamp count, and cashback balance. POST /checkPassExistsByPhone is a lighter alternative if you only need a yes/no check.

How do I send a push notification to pass holders through Jentic?

Search Jentic for 'send a Boomerangme push notification', load the sendInfoPush schema, and execute it with the templateId and message body. Use pip install jentic to add the SDK, then call client.search, client.load, and client.execute in that order.

What are the rate limits for the Boomerangme API?

Boomerangme does not document public rate limits in the OpenAPI spec; merchants on standard plans report comfortable headroom for typical retail volumes. For high-frequency lookups, batch requests where possible and cache template lists between calls.

Is the Boomerangme API free to use?

API access is included with a paid Boomerangme merchant subscription rather than billed separately. You authenticate with the access token issued from your merchant dashboard; there is no additional per-call fee from Boomerangme for endpoints in this spec.

Can I limit what my agent is allowed to do with the Boomerangme API?

Yes. Jentic One is self-hosted, so you run it and your own rules decide which Boomerangme operations and credentials the agent may use. Because Boomerangme carries client and pass details in the request body rather than the URL path, you scope the agent to only the operations it needs, such as createClient and createPass, and leave out others like sendInfoPush unless the agent requires them. Every operation you allow is one you have explicitly chosen, and the access token stays in your Jentic One instance rather than the agent's context.