Shypple Overview
      Back to home
      1. Knowledge base
      2. Shypple Overview

      What is an API?

      The most frequently asked questions about API’s answered.

      In the fast-paced world of technology and data exchange, APIs (Application Programming Interfaces) play an essential role in enabling seamless communication between various software systems. As the use of APIs continues to grow, so do the questions surrounding them. In this article, we'll dive into some of the most frequently asked questions about APIs to provide clarity and insight into this essential aspect of modern software integration.

                                                                                                                      1. What is an API?

      API, which stands for Application Programming Interface, serves as a bridge between computers or computer programs, facilitating the exchange of data. For instance, the Shypple public API empowers customers to access their data on Shypple directly from their systems, whether it's SAP, Exact, or data warehouses. When two systems establish a connection through an API, they are considered integrated, allowing for seamless data transfer.

      2. What is a webhook?

      Webhooks are automated messages dispatched by applications in response to specific triggers or actions. It's important to note that Shypple's API doesn't operate with webhooks. Instead, it necessitates making a call each time to check for changes, ensuring that customers stay in the loop regarding any updates or alterations.

                                                                                                                      3. What is the difference between push and pull?

      When talking about APIs, you may come across the terms "push" and "pull." In a pull scenario, the customer actively requests information, which is the current operating model of our API. In contrast, a push API involves the server automatically sending information as soon as it becomes available, typically associated with webhooks.

                                                                                                                    4. What is the difference between API and EDI?

      EDI, or Electronic Data Interchange, is a batch-driven process involving bundled information. In contrast, APIs offer real-time or near-real-time information access. While EDIs are commonly connected to external trading partners through protocols like AS2, OFTP2, or VAN, APIs can connect to API-enabled cloud applications, providing more flexibility in modern data exchange.

                                                                                                                    5. Is it possible to POST data to the API endpoint?                         

      Currently, our API supports sending data with a POST request, although with some limitations. This feature is mainly designed for posting Purchase Orders, providing a particular but valuable option for specific situations.

                                                                                                                    6. Does the API also work for AIR shipments?

      Absolutely! All the features that we support for sea shipments are equally applicable to air shipments, ensuring a consistent and reliable experience across different modes of transportation.

                                                                                                                    7. Does Shypple support customers with building the integration?                                                                                   

      Shypple has developed an open API to facilitate seamless integration with our systems. However, it's essential to note that this is a standard API, and each customer connection requires development efforts from the client's side. Shypple does not undertake the integration process on behalf of customers. Should you require assistance or guidance, don't hesitate to reach out to your dedicated Shypple Customer Success Manager for support.

                                                                                                                    8. What level of information do we support with the API?               

      Shypple's API provides different levels to access information:

      • Shipment Level: Retrieve information about one or all of your shipments.

      • Container Level: Access information about one or all of your containers.

      • Booking Level: Retrieve details about one of your bookings.
      • Purchase Order Level: Create or obtain information about a purchase order.

      💬 To sum it up, APIs are vital for today's software systems, helping businesses connect and share data effortlessly. It's crucial to grasp the basics and how to use them effectively in the digital age. If you have questions or need help with Shypple's API, reach out to our product team at integrations@shypple.com. Embrace the potential of APIs to enhance your data integration.