This Symfony Flex "API-only" app provides GraphQL access to the Collmex API.
- Important Notes
- Features
- Dependencies
- Installation
- Configuration
- Tools
- Roadmap & Vision
- Collmex API Documentation
- Development notes
This project is in a very early stage of development and is therefore not yet suitable for productive use!
Currently there
- are NO access restrictions to objects or object fields
- is NOT any kind of authentication, so ONLY run locally or behind a firewall
- are NO automated tests
GraphQL representation of the Collmex type "Lieferung" with the following nested object types:
- Client (Collmex "Firma")
- DeliveryItem (Subtype for delivery position data)
- client_id (Collmex "Firma Nr")
- delivery_id (Collmex "Lieferungsnummer")
GraphQL representation of the Collmex type "Produkt" with the following nested object types:
- ProductGroup (Collmex "Produktgruppe")
- Client (Collmex "Firma")
- TaxRate (Collmex "Steuerklassifikation")
- ProductType (Collmex "Produktart")
- PriceGroup (Collmex "Preisgruppe")
- ShippingGroup (Collmex "Versandgruppe")
- ProcurementType (Collmex "Beschaffungsart")
- CostingType (Collmex "Kostenermittlung")
- Supplier (Collmex "Lieferant")
- ProductRaw (Raw data, as received from the Collmex API)
- client_id (Collmex "Firma Nr")
- product_id (Collmex "Produktnummer")
None yet.
This project depends on the Collmex API PHP SDK. Kudos to this project team, keep up the great work!
GraphQL is provided by the OverblogGraphQLBundle.
Install with Composer:
composer install
Put the following secrets in your env.dev.local, or better into Symfony's Vault:
- COLLMEX_API_CUSTOMER_ID
- COLLMEX_API_USER
- COLLMEX_API_PASSWORD
The composer.json requires the package "overblog/graphiql-bundle" for dev installations.
Append /graphiql to your app URL in order to open the GraphiQL UI.
We recommend using the Chrome plugin of Altair's GraphQL client.
See ROADMAP.md for roadmap and release planning.
- Further Collmex API types
- GraphQL Mutation (Create / Update)
- Nested GraphQL resolvers
- This will require caching, as this feature will depend on multiple type requests
- A caching layer in order to reduce direct API request to Collmex, which are restricted to 10.000 requests a day
Please use dicussions and issues for suggestions!
https://www.collmex.de/cgi-bin/cgi.exe?1005,1,help,api
- Create GraphQL schema definition for raw Collmex data in config/graphql/types/
- Create GraphQL schema with sub data types in config/graphql/types/
- Add schema definitions to config/graphql/Query.types.yml
- Add data type request in src/Repository/Collmex/ApiClient/Type/
- Add data type entity in src/Entity/Type/
- Add data type repository in src/Repository/Type/
- Add GraphQL resolvers in src/GraphQl/Resolver/Type/