The Local API allows you to initiate a payment, print a ticket or fetch transactions history from the Yavin terminal connected to a local network.
You can either use local IP or Network Service Discovery compatible with Apple Bonjour. The second option could be the preferred integration as it prevents IP changes, see the documentation here.
<aside> ⚠️ To operate correctly, the terminal must be necessarily connected to the local network. It's on this IP address that the corresponding URL can be called to awake the terminal. The local network must be connected to internet to approve a transaction.
</aside>
Don't forget the port number 16125 in the URL. It's easy to remember:
<aside> 💡 This API only accepts parameters following the camelCase and snake_case convention depending on the object
</aside>
The current API integration version is v4 which takes a first-order position in endpoints.
| API Version | Documentation | Last updated date |
|---|---|---|
v4 |
- | August 22, 2024 |
v1 |
- | May 2, 2022 |