index.html

---
layout: default
---

<section class="mb-m">
  <h2 class="mb-m">
    <i class="fas fa-terminal"></i>
    Welcome
  </h2>
  <p class="mb-m">
    to the shipcloud developer portal where you - the developer - will hopefully get all the
    information you need to get started with integrating shipcloud into your own service, shop, app
    or other crazy idea.
  </p>
  <p class="mb-m">
    This is supposed to be your one stop for all developer needs. If you have any questions, feel free to contact us.
  </p>
  <p>
    If there's anything missing in this portal, you've found a typo, bug or something isn't clear, the developer
    portal is build as a public repository on github. Feel free to fork it, change things, make a pull request or
    even run your own local version of it.
  </p>
</section>
<section class="mb-m">
  <h2 class="mb-m">
    <i class="fas fa-book"></i>
    Getting started
  </h2>
  <p>
    If you want to start testing our services fast - this is the way to go! Just follow these
    simple steps:
  </p>
  <ul class="list-outside list-disc ml-m">
    <li>
      First of all you
      <a href="https://app.shipcloud.io/de/users/sign_up?plan=developer" target="_blank">
        register for our free developer plan.
      </a>
    </li>
    <li>
      Afterwards you can
      <a href="https://app.shipcloud.io/de/users/api_key" target="_blank">
        get your api keys from our backoffice
      </a>
    </li>
    <li>
      Start implementing your first api call using our
      <a href="{{ site.baseurl }}/reference/">api reference</a>.
    </li>
  </ul>
</section>
<!-- <section class="mb-m">
  <h3 class="mb-m">
    Integration guide
  </h3>
  <p>
    If you like to know the ins and outs of our services and our api or want to write a new
    plugin, extension, module, or library for your software or programming language, the best way
    to get started is by downloading and reading the
    <a href="{{ site.baseurl }}/concepts/#integration-guide">
      integration guide.
    </a>
  </p>
  <p>
    In our integration guide we're trying to give you the best possible overview of what
    shipcloud is trying to support you with. We're also providing you with an overview of
    possible use cases and pitfalls when implemeting a shipping solution.
  </p>
</section> -->
<section class="mb-m">
  <h3 class="mb-m">
    Concepts
  </h3>
  <p>
    Afterwards you should consider reading about a few of the
    <a href="{{ site.baseurl }}/concepts/">
      concepts
    </a>
    and principles that our api and services are adhering to. On our concepts page we're trying
    to explain stuff like authentication, versioning, timeouts and a lot more basic and important
    things you should know about when working with our api.
  </p>
</section>
<section class="mb-m">
  <h3 class="mb-m">
    Shipping Journeys
  </h3>
  <p>
    Our API provides seamless integration to create shipping labels directly from your backend 
    system, addressing two primary shipping journeys: "ship" and "checkout to ship".
    <ol class="list-outside list-decimal">
      <li>
        <a href="{{ site.baseurl }}/reference/#creating-a-shipment"><b>Ship</b></a>: The “Ship" 
        journey empowers customers to effortlessly generate shipping labels for orders directly 
        from their backend systems. Whether you are processing orders manually or automating 
        your fulfillment process, our API provides a straightforward solution for creating 
        shipping labels with ease.
      </li>
      <li>
        <a href="{{ site.baseurl }}/concepts/#checkout"><b>Checkout to Ship</b></a>: In addition to 
        the “Ship” journey, our API also supports the “Checkout to Ship” journey, designed to 
        enhance the end-customer experience during the checkout process. With this functionality, 
        customers can select their preferred carrier service option directly within the checkout 
        interface of your shop system. Once the order is confirmed, the shipping label is 
        seamlessly generated from your backend system, streamlining the entire fulfillment process.
      </li>
    </ol>
  </p>
</section>
<section class="mb-m">
  <h2 class="mb-m">
    <i class="fas fa-envelope-open"></i>
    Newsletter
  </h2>
  <p>
    Always stay up to date with our
    <a href="{{ site.baseurl }}/newsletter">
      developer journal
    </a>
    where we're writing about changes and updates to our api, providing you with useful insights
    and keeping you up to date about where you can meet us to talk about the development side of
    our services.
  </p>
</section>
<section class="mb-m">
  <h2 class="mb-m">
    <i class="fas fa-code"></i>
    Not a developer?
  </h2>
  <p>
    Don't panic! We've got you covered! There are already a hand full of
    <a href="{{ site.baseurl }}/integrations">
      plugins
    </a>
    written by other developers for a lot of the largest online shopping software solutions.
    We're also directly integrated into a few shopping services like Gambio, Jimdo and
    VersaCommerce.
  </p>
</section>
<section class="mb-m">
  <h2 class="mb-m">
    <i class="fas fa-life-ring"></i>
    Need help?
  </h2>
  <p>
    If at any point you're getting the feeling that you're lost or you're simply having a
    question, because something we're describing isn't clear to you. Don't hesitate to
    <a href="{{ site.baseurl }}/support">contact us</a>.
  </p>
</section>