Integrify Clopos

[!Caution] Integrify is unofficial library, even though it is based on official documentation.

Integrify

Integrify is a library that simplifies API integrations. This library is designed for Clopos integration.

Test Publish Package version Netlify Status

Downloads Supported Python versions Coverage

Documentation: https://integrify.mmzeynalli.dev/integrations/clopos/about/

Source code: https://github.com/Integrify-SDK/integrify-clopos-python

Official Documentation (v1.0.1)

English

Main functionalities

  • Library supports both sync and async requests.
  • All of the function and classes has been documented.
  • As all of the functions/variables/classes has been typed, type-hinting is active
  • The flow of the requests has been explained in the documentation.

Installing

pip install integrify-clopos

Usage

To use these requests you need to set these environmental variables:

Variable Name Purpose Header equivalent Default Value
CLOPOS_CLIENT_ID Client ID given by Clopos (used only for auth) - -
CLOPOS_CLIENT_SECRET Client Secret given by Clopos (used only for auth) - -
CLOPOS_BRAND Brand that you want to request x-brand -
CLOPOS_VENUE_ID Venue/Branch id that you want to request x-venue -

Note that, these values MIGHT be unset. In this case, you should send it in header of each request. Let's say you want to request menu categories of two venues separately:

# CLOPOS_CLIENT_ID, CLOPOS_CLIENT_SECRET and CLOPOS_BRAND have been set as env variables
from integrify.clopos.client import CloposClient

venue1_id=1
venue2_id=2

token1 = CloposClient.auth(venue_id=venue1_id).body.token
categories1 = CloposClient.get_categories(headers={'x-token': token1, 'x-venue': venue1_id}).body.data

token2 = CloposClient.auth(venue_id=venue2_id).body.token
categories2 = CloposClient.get_categories(headers={'x-token': token1, 'x-venue': venue2_id}).body.data

If you want to fetch categories from different brand, just manually add x-brand to the header.

For auth, instead of headers, you will just send these as params.

# No env was set
from integrify.clopos.client import CloposClient

client_id='eNUKI04aYJRU6TBhh5bwUrvmEORgQoxM'
client_secret='dqYkWUpDjzvKOgbP3ar8tSNKJbwMyYe1V5R7DHClfSNYkap5C5XxRA6PmzoPv1I2'
brand='openapitest'
venue_id='1'

token = CloposClient.auth(client_id=client_id, client_secret=client_secret, brand=brand, venue_id=venue_id).body.token

List of requests

Request function Purpose Clopos API
auth Authenticate, get token /open-api/auth
get_venues Get list of venues/branches /open-api/venues
get_users Get list of users /open-api/users
get_user_by_id Get user by id /open-api/users/{id}
get_customers Get list of customers /open-api/customers
get_customer_by_id Get customer by id /open-api/customers/{id}
get_customer_groups Get list of customer groups /open-api/customer-group
get_categories Get list of menu categories /open-api/categories
get_category_by_id Get menu category by id /open-api/categories/{id}
get_stations Get list of stations /open-api/stations
get_station_by_id Get station by id /open-api/stations/{id}
get_products Get list of products /open-api/products
get_product_by_id Get product by id /open-api/products/{id}
get_sale_types Get list of sale types /open-api/sale-types
get_payment_methods Get list of payment methods /open-api/payment-methods
get_orders Get list of orders /open-api/orders
get_order_by_id Get order by id /open-api/orders/{id}
create_order Create new order /open-api/orders
get_receipts Get list of receipts /open-api/receipts
get_receipt_by_id Get receipt by id /open-api/receipts/{id}
create_receipt Create a new receipt /open-api/receipts
delete_receipt Delete a receipt /open-api/receipts/{id}

Note that, each request should have parameter headers={'x-token': token}. For example:

# CLOPOS_CLIENT_ID, CLOPOS_CLIENT_SECRET, CLOPOS_BRAND and CLOPOS_VENUE_ID have been set as env variables

from integrify.clopos.client import CloposClient

token = CloposClient.auth().body.token
user = CloposClient.get_user_by_id(id=1, headers={'x-token': token}).body.data

[!Caution] Integrify is unofficial library, even though it is based on official documentation.

Other supported integrations

Servis Əsas sorğular Bütün sorğular Dokumentləşdirilmə Real mühitdə test Əsas developer
EPoint ✅ loading Tam ✅ Miradil Zeynallı
KapitalBank ✅ ✅ Tam ✅ Zaman Kazımov
LSIM ✅ ✅ Tam ✅ Miradil Zeynallı
Posta Guvercini ✅ ✅ Tam ✅ Zaman Kazımov
Azericard ✅ loading Tam loading Miradil Zeynallı
Clopos ✅ ✅ Full loading Miradil Zeynallı
Payriff loading loading loading loading Vahid Həsənzadə

Project links

Data verified by PyPI on Aug 11, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for mmzeynalli from gravatar.com mmzeynalli

Credits

PyPI data
Data sourced directly from PyPI's database.

Author: mmzeynalli

GitHub Statistics

Data verified by PyPI on Aug 11, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License

GNU General Public License v3 or later (GPLv3+) (GPL-3.0-or-later)

Requires

Python >=3.9

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

integrify_clopos-0.1.0.tar.gz (37.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

integrify_clopos-0.1.0-py3-none-any.whl (47.8 kB view details)

Uploaded Python 3

File details

Details for the file integrify_clopos-0.1.0.tar.gz.

File metadata

  • Download URL: integrify_clopos-0.1.0.tar.gz
  • Upload date:
  • Size: 37.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for integrify_clopos-0.1.0.tar.gz
Algorithm Hash digest
SHA256 903b2dffbbf5685674f2a5dc79198afbff9319708ef9465b820f4735a116357a
MD5 5079d0ffd793e19ae71642a38fc291b6
BLAKE2b-256 5b9bb12b2761e11b731a64f914c1263ea46af036a66b8889308b68c46193a205

See more details on using hashes here.

Provenance

The following attestation bundles were made for integrify_clopos-0.1.0.tar.gz:

Publisher: publish.yml on Integrify-SDK/integrify-clopos-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file integrify_clopos-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for integrify_clopos-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a0e78304f3cb5bcff3be13afc273b30454c2179490980ac15f46e27a3bd47f56
MD5 50cf4f63552cc11c65b7baa983cc08a3
BLAKE2b-256 79c739bdaff98d25abfbf453fe69d25471f205a839a1bb9ff64405142cdb09a8

See more details on using hashes here.

Provenance

The following attestation bundles were made for integrify_clopos-0.1.0-py3-none-any.whl:

Publisher: publish.yml on Integrify-SDK/integrify-clopos-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page