Contents x
    How does the ProMaterial API work?
    • 15 Jun 2022
    • 1 Minute to read
    • Contributors
    • Print
    • Dark
      Light
    Contents

    How does the ProMaterial API work?

    • Updated on 15 Jun 2022
    • 1 Minute to read
    • Contributors
    • Print
    • Dark
      Light
    Article summary

    We use GraphQL for our APIs.
    You can test on our stage system and implement for our production system. Here, you find the URLs.

    Using GraphQL

    The BusinessManager, each DistributionGate and the BookingGate only have one endpoint.
    Send requests via POST.
    In the request body, specify which data is to be returned.
    GraphQL has a syntax completion included.
    If there is no server or connection error, the API returns status code 200..
    To use the API from your application or tools like Postman or Insomnia, add "/graphql" to the base URLs below.

    You can try the API directly in the browser using the GraphiQL interface (note the "i"). Add "/api" to the base URL to go to GraphiQL. You need to obtain an authorization token first.

    Find more information about GraphiQL in the other chapters.

    Stage environment

    We need your static IP adress so that you can access our stage environment.

    The URLs are created like this:

    DistributionGate: {name}.dg.stage.promaterial.com

    BookingGate: {name}.bg.stage.promaterial.com

    Production environment

    DistributionGate: {name}.dg.prod.promaterial.com

    BookingGate: bg.promaterial.com

    Was this article helpful?
    What's Next