# Welcome to Hatch Apps

Welcome to the Hatch Apps Docs.

We use this website to help our customers and partners understand all the available products, features, integrations, and services available to them on the Hatch Apps platform. We update the docs weekly.

Hatch Apps is a no-code platform for teams to build mobile apps, APIs, databases, and more. We save companies time and money on software development by putting them in full control.

For more information about Hatch Apps, visit our website at <https://www.hatchapps.com>

<figure><img src="/files/iXbwyE1eANQ942Jc3Ix8" alt=""><figcaption></figcaption></figure>


# Glossary

* **Member**: A subscription paying customer of Hatch Apps.&#x20;
* **App**: Software that is built by a member of Hatch Apps. This software can be accessible to end users via iOS, Android, Web, API, Database, or other mediums.&#x20;
* **Platform**: The centralized product experience of Hatch Apps available as a web application in the browser.&#x20;
* **Product**: An individual no-code product availabe on the [Product](https://platform.hatchapps.com/products) page.&#x20;
* **Ecosystem**: A partner of Hatch Apps that provides value to our members. These include integrations, marketplace vendors, distributors, VC funds, accelerators, sponsors, and more.
* **Multiplayer**: The ability for members to work together in real time any where in the Hatch Apps platform.&#x20;
* **Components**: Pre-built pieces of software that can be used by members to drag-and-drop into their app.


# Use Cases

By use case

* **Full stack mobile app:** A company uses Hatch Apps to build a mobile app and API.&#x20;
* **Stand alone mobile app**: A company uses Hatch Apps to build a mobile app connected to an existing API.&#x20;
* **Stand alone API**: A company uses Hatch Apps to build an API connected to other parts of their existing stack.&#x20;
* **API connected to another no-code product**: A company uses Hatch Apps to build an API that is connected to an app built with Adalo, Glide, Unqork, or another service.&#x20;
* **Pass through API**: A company uses Hatch Apps to build an API that aggregates data from multiple sources into a single endpoint.&#x20;
* **Stand alone Database**: A company uses Hatch Apps to build a SQL database&#x20;
* **Workflow Automation**: A company uses Hatch Apps to build a mobile app, API, and / or database that is integrated with other apps to automate a specific workflow.&#x20;
* **Business Process Management**: A company uses Hatch Apps to automate a business process by connecting a mobile app, API, and database to other apps.&#x20;
* **Robotic Process Automation**: A company uses Hatch Apps to automate a business process with smart decisioning and logic by connecting a mobile app, API, and database to other apps.&#x20;
* **Case Management**: A company uses Hatch Apps to manage a mobile workflow with customers or employees on-the-go.&#x20;
* **Mobile Data Capture**: A company uses Hatch Apps to build a mobile app and API to capture data available to mobile devices. This includes text, photos, videos, GPS location, and more.&#x20;
* **Prototyping**: A company uses Hatch Apps to prototype and validate a new idea before investing in software development.&#x20;

By persona&#x20;

* **Entrepreneur**: An entrepreneur uses Hatch Apps to build a mobile app and API to launch a new idea.&#x20;
* **Association**: An association uses Hatch Apps to build a mobile app for their members to improve renewal rates, build community, and send announcements. The mobile app is connected to their AMS for authentication, payments, members list, and more.&#x20;
* **Enterprise**: An enterprise uses Hatch Apps to build a mobile app connected to an existing API. This can be to manage users, payments, notifications, data, and more.&#x20;
* **Agency**: An agency uses Hatch Apps to build mobile apps and APIs for their clients.&#x20;
* **Freelancer**: A freelancer uses Hatch Apps to build mobile apps and APIs for their clinets.&#x20;
* **Non profit**: A non profit uses Hatch Apps to build a mobile app to convey their mission, build a community, and engage donors.&#x20;

By role

* **Designers**: A designer uses Hatch Apps to design and build at the same time. No more handoffs to the engineering team or waiting for feedback. Drag-and-drop components and customize them with the rest of the design team. Like Figma for software.
* **Engineers**: An engineer uses Hatch Apps to build and manage an API. Configure permissions, objects, rule, and routing instantly. Test your data and build custom workflows in-browser.
* **Business**: A business user uses Hatch Apps to build software without coding. No more waiting for design or engineering. Drag-and-drop components and customize them as fast as you can think. If you need help, purchase a vendor on the Marketplace.&#x20;


# Sales Deck

<figure><img src="/files/gt6J8pMWgnYzyW331iYb" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/9x44SQwMvLpHJGybKmhl" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/VzAmlplBFhhArIY6wYTf" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/Ht91VOZZY8wN37QNy881" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/epTkj7bsbwDkf56MbM0l" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/ch1Gad397ZpgDwts5qri" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/Yk8aJm48WEQ7tBX1vvz6" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/rOSzJs7UrY1XZIMdzLkD" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/Q4juqQ94AnccBCVl2UWA" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/Kge8TjZRtRYictRqbABI" alt=""><figcaption></figcaption></figure>


# Overview

The Hatch Apps Platform is the centralized experience for members. Access to everything starts with the platform.&#x20;

A few things to note about the platform:&#x20;

* The platform is available as a web app in the browser.&#x20;
* The platform is hosted on our cloud servers with AWS.&#x20;
* The platform is a multi-tenant environment.&#x20;

There are 3 ways to enter the platform: Creating a new account, Logging in as a returning user, and Joining a team.&#x20;

Create a new account:&#x20;

1. Go to the [Sign Up](https://platform.hatchapps.com/signup) page.&#x20;
2. Enter your company email, first name, last name, company name, and optional referral code.
3. Click on the Next button to proceed to onboarding.&#x20;

<figure><img src="/files/22Eq48SMYsausqAK9cwe" alt=""><figcaption></figcaption></figure>

Logging in as a returning user:&#x20;

1. Go to the [Log In](https://platform.hatchapps.com/login) page.&#x20;
2. Enter your company email and password.&#x20;
3. Click on the "Log In" button to proceed to the platform.&#x20;

<figure><img src="/files/BeAHDwsBYqxB9VqTHfBp" alt=""><figcaption></figcaption></figure>

Joining a team:&#x20;

1. When invited to join a team, you'll receive an automated email with subject line "\[NAME] invited you to Hatch Apps".&#x20;
2. Follow the instructions in the email making sure to use the temporary password assigned to your account.&#x20;
3. Once in the platform, go to [Settings](https://platform.hatchapps.com/settings) page under Account Information to update your password.&#x20;

<figure><img src="/files/1wHWUWA3PrlGFFSYZDw0" alt=""><figcaption></figcaption></figure>


# Features


# Home

The Hatch Apps Home page is the centralized dashboard for our members. Our key objective is to convey ROI (return on investment) to our members.&#x20;

* **Team members**: The number of team members that have accepted their invite to the platform.&#x20;
* **Hours saved**: An estimated calculation of how many hours your company has saved using the platform and no-code products.&#x20;
* **Money saved**: An estimated calculation of how much money your company has saved using the platform and no-code products.&#x20;
* **Products**: Total number of no-code products on the platform.&#x20;
* **Marketplace**: Total number of marketplace vendors on the platform.&#x20;
* **Deals**: Total number of deals on the platform. &#x20;

Note: Our platform automatically tracks the money saved by your company. If the total doesn't add up to $2,499 on a given year, a refund is automatically issued to you. We estimate 10x value to our customers (i.e. you'll save \~$25,000 per year on software development costs with Hatch Apps).&#x20;

<figure><img src="/files/8qCbfLHYu4MsnEJ5iVu3" alt=""><figcaption></figcaption></figure>


# Resources

On the bottom of the Home page, we provide members with Resources.&#x20;

* **Build an app strategy**: We've compiled a document with how to get the most out of the Hatch Apps platform.&#x20;
* [**App calculator**](https://calculate.hatchapps.com/): The publicly available app calculator helps companies assess the time and money required to build their app.&#x20;
* **Monthly webinar**: Every month, we record a webinar to show members new features to the platform and highlight use-cases.&#x20;
* **Hatch Apps World**: This is our annual virtual event that is available to all members. During this virtual conference, we invite guest speakers, discuss no-code trends, and have breakout sessions.&#x20;

<figure><img src="/files/kcTqkUpvV2y3MJFrVfGb" alt=""><figcaption></figcaption></figure>


# Products

The Products page gives members access to all available no-code products. To access any product, click on the "Get Started" button and log in using your Hatch Apps platform credentials. We use our own secure SSO to authenticate users into our suite of products.&#x20;

* **Mobile App Builder**: Build an app for iOS and Android without coding. Our marquee no-code builder let's you build your app visually with an intuitive drag-and-drop interface.
* **API Builder**: Build a hosted back end and API without coding. You can use the API with any app, built with Hatch Apps or not. Create a REST API with advanced user controls, schema, and permissions.
* **API Tester**: Test an API in the browser without coding. Select your method, enter your URL, and customize parameters seamlessly. No third party software required.
* **Software Insurance**: Purchase software development insurance backed by Hatch Apps for $99 per month. Submit a claim to receive up to $10,000 in Marketplace Credits.

<figure><img src="/files/213KEMGXJOwonRqYw5Zt" alt=""><figcaption></figcaption></figure>

<br>


# Marketplace

The Marketplace page gives members the ability to purchase custom services to compliment their app strategy.&#x20;

To purchase a marketplace service:&#x20;

1. Go to the [Marketplace](https://platform.hatchapps.com/marketplace) page.&#x20;
2. Click on "Purchase" next to any service.&#x20;
3. In the modal, you'll see the exact service and amount.&#x20;
4. Click on "Pay now" to process the payment for the service. Note that the card on file will be charged.&#x20;

Here are all available marketplace services:&#x20;

* **Onboarding Specialist**: Hire an onboarding specialist to build your app using our Mobile App Builder. The specialist will work with you to identify scope, integrations, user engagement, and more.
* **App Manager**: Hire an app manager to maintain your app using our Mobile App Builder. The manager will make app updates, track analytics, update integrations, and more to keep your app going.
* **App Designer**: Hire a designer to customize your app using our Mobile App Builder. The app designer will pick the right components, customize them, match to your brand, and more.
* **App Store Screenshots**: Hire a designer to build your custom app store screenshots. The screenshots are for both iOS and Android, including all phone sizes.
* **Mobile App Design**: Hire a designer for your custom mobile app. The designs are delivered on Figma with user flows, animations, custom branding, and more.
* **Web App Design**: Hire a designer for your custom web app. The designs are delivered on Figma with user flows, animations, custom branding, and more.
* **Deck Design**: Hire a designer for your presentation deck. Specialized in investor, sales, and board decks.
* **Website Design**: Hire a designer for your custom website. The designs are delivered on Figma with user flows, animations, custom branding, and more.
* **Mobile App Development**: Hire an engineer to build your custom mobile app. The development is all inclusive: designs, development, deployment, and maintenance.
* **Web App Development**: Hire an engineer to build your custom web app. The development is all inclusive: designs, development, deployment, and maintenance.
* **Chatbot Development**: Hire an engineer to build your custom chatbot. The development is all inclusive: designs, development, deployment, and maintenance.
* **Website Development**: Hire an engineer to build your custom website. The development is all inclusive: designs, development, deployment, and maintenance.
* **Blockchain Integration**: Hire an engineer to integrate a blockchain smart contract into your app. The development is all inclusive: integration, development, deployment, and maintenance.
* **API Development**: Hire an engineer to build a custom API. The development is all inclusive: schema, development, deployment, and maintenance.
* **Penetration Testing**: Hire an engineer to do penetration testing on your infrastructure. This service is open-ended to your specific needs including injection flaws, authentication issues, data exposure, and more.
* **Custom Development**: Hire an engineer to do custom front end or back end development for your app. This service is open-ended to your specific needs.

To redeem marketplace credit:&#x20;

1. Go to the [Marketplace](https://platform.hatchapps.com/marketplace) page.&#x20;
2. Click on "Purchase" next to any service.&#x20;
3. In the modal, the "Amount" will reflect the marketplace service price minus the available credit.&#x20;
4. When you click "Pay Now", the card on file will be charged the amount shown. The Marketplace Credit page will also update.&#x20;

<figure><img src="/files/rdS529maHG3KGA3UHp5N" alt=""><figcaption></figcaption></figure>

<br>


# Deals

The Deals page gives members exclusive discounts and perks to other software companies. Each deal is hand selected by our partnerships team.&#x20;

To redeem a deal:&#x20;

1. Go to the [Deals](https://platform.hatchapps.com/deals) page.&#x20;
2. Click on "Redeem Deal" next to any deal.&#x20;
3. In the modal, you'll see instructions for how to redeem the deal.&#x20;

<figure><img src="/files/ATAgnc1JwXjFZn00k7Cz" alt=""><figcaption></figcaption></figure>


# Support


# Forum


# Docs

Our product docs (i.e. this website) is publicly available and updated weekly.&#x20;

To request additional information or new pages, contact us here: <support@hatchapps.com>


# Email support

Contact email support here: <support@hatchapps.com>&#x20;

Note that only members have access to email support. This is not available to students or free tier users.&#x20;


# In app support tickets

The Support page gives members multiple options to find what they are looking for. One option is in app support tickets.&#x20;

To start a support ticket:&#x20;

1. Go to the [Support](https://platform.hatchapps.com/support) page.&#x20;
2. Click on Submit a Ticket.&#x20;
3. In the modal, enter the Topic, Severity, Subject, and Description. Please be as detailed as possible to help our support team understand the situation.&#x20;
4. Once submitted, you will receive an automated email between you and our support team. Within 24 hours, a member of our support team will follow up via email.&#x20;
5. Once the issue is resolved, the ticket will be marked as closed on the Support Tickets data table on the bottom of the page.&#x20;

Note that only members have access to email support. This is not available to students or free tier users.&#x20;

<figure><img src="/files/dotErkFWdK26dJmV7Vuy" alt=""><figcaption></figcaption></figure>


# Enterprise SLA

We provide members with an Enterprise SLA for an additional $36,000 per year.

Here's what it includes:&#x20;

* **Customer Success Manager**: A dedicated account manager with weekly meetings.&#x20;
* **API Access**: Access to the Hatch Apps API to build custom integrations or workflows.&#x20;
* **Single Tenant Environment**: If needed, a custom deployment of the Hatch Apps platform instance to be a single tenant environment or deployed on premise.&#x20;
* **24 / 7 Support**: In app and email support with a 1 hour response time.&#x20;
* **Forum**: Access to the in app forum to discuss with other members.&#x20;
* **Docs**: Access to these product docs.&#x20;


# Account Manager

For members on the Enterprise tier, we provide an Account Manager to the account.&#x20;

Here's exactly what's included with an Account Manager:&#x20;

* 4 week white glove onboarding phase.
* Weekly meetings to review goals and implement changes. &#x20;
* Liaison between our support and integrations team.&#x20;
* Annual in person working session for a day on-site.&#x20;


# Account


# Payments

Members can track payments, change payment methods, and more directly from the platform.&#x20;

To add, edit, or delete your payment method on file:&#x20;

1. Go to the [Settings](https://platform.hatchapps.com/settings) page.&#x20;
2. Click on "Payment Methods" on the top navigation.&#x20;
3. In the form, enter your credit card information.&#x20;
4. Click on Save and wait for the loading animation to show your card details.&#x20;

<figure><img src="/files/lL8NOLKcVnke55rA9Su9" alt=""><figcaption></figcaption></figure>

To upgrade from a free to paid member:&#x20;

1. Click on any feature in the platform.&#x20;
2. In the modal, click on Upgrade Now.&#x20;
3. In the form, enter your credit card details. Note that this will become your default payment method on file.&#x20;
4. Click on Pay Now for your membership to be activated.&#x20;

<figure><img src="/files/qeMSdBQGtMyfNx9W6hzV" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/qf91U1AGu8dIZim2q3W3" alt=""><figcaption></figcaption></figure>

To track payments for both the annual subscription and marketplace services:&#x20;

1. Go to the [Settings](https://platform.hatchapps.com/settings) page.&#x20;
2. Click on "Payments" on the top navigation.&#x20;
3. View all transactions in the data table.

&#x20;

<figure><img src="/files/jPxKIFWOsqqnxjxjnHtX" alt=""><figcaption></figcaption></figure>


# Team management

From the Team page members can manage their organization with advanced permissions.&#x20;

The first person at your organization to register for Hatch Apps becomes the "Super Admin". The Super Admin can then assign other Admins.&#x20;

Here are the available team permissions:&#x20;

* Admin&#x20;
* Manager
* Designer
* Developer
* Business
* Contractor&#x20;

To add a team member:&#x20;

1. Go to the [Team](https://platform.hatchapps.com/team) page.&#x20;
2. Click on Add Team Member.&#x20;
3. In the modal, enter their First Name, Last Name, Email, and Role.&#x20;
4. Click Submit.&#x20;
5. In the data table, click on the 3 vertical dots and then click on Invite. This will now send your team member an automated email with a link, their email, and a temporary password.&#x20;

To edit a team member's information:&#x20;

1. Go to the [Team](https://platform.hatchapps.com/team) page.&#x20;
2. In the data table, click on the 3 vertical dots and then click on Edit.&#x20;
3. In the modal, edit the information.&#x20;
4. Click on Save when done.&#x20;

To delete a team member's information:&#x20;

1. Go to the [Team](https://platform.hatchapps.com/team) page.&#x20;
2. In the data table, click on the 3 vertical dots and then click on Delete.&#x20;
3. In the modal, confirm you want to delete.&#x20;
4. This team member will no longer have access to the Hatch Apps platform or products.&#x20;

We have built our own SSO system to enable members to enter the platform and individual products with the same login credentials. If you have any questions, contact us at: <support@hatchapps.com>

<figure><img src="/files/idhdmJUBZgkcpCDpCjiu" alt=""><figcaption></figcaption></figure>


# Multiplayer collaboration

The entire Hatch Apps ecosystem has been built to support multiplayer collaboration. Like a Google Doc or Figma file, organizations can collaborate in real-time by viewing who's in the platform and what they are specifically doing.&#x20;

* **Avatar**: User avatars appear on the top of the page. You only see other users on the same page as you.&#x20;
* **Cursor**: Users cursors are visible and correspond to the color of their avatar. The user name appears next to the cursor.&#x20;
* **Products**: Users can continue to collaborate within individual products. Specifically for drag-and-drop functions, users can make changes to an app together.&#x20;

<figure><img src="/files/2yKtFiFIdI5ZgCQfFqTR" alt=""><figcaption></figcaption></figure>


# SSO

We have built our own SSO system to enable members to enter the platform and individual products with the same login credentials.&#x20;

<figure><img src="/files/MX4ZgMUH0ea8MrkoeOpV" alt=""><figcaption></figcaption></figure>

If you have any questions, contact us at: <support@hatchapps.com>


# Referral program

Refer a friend or colleague to Hatch Apps and you’ll both receive $250 in cash when they become a paid member.

1. Click on the gift icon on the top navigation bar.&#x20;
2. Share the referral code with a friend, colleague, or audience. Have them use the referral code when signing up.&#x20;
3. Once complete, an Account Manager will contact you via email within 24 hours to send you the money.

<figure><img src="/files/1gRnQKHFPxtCZDlH9t2O" alt=""><figcaption></figcaption></figure>


# Security

We take security seriously. Below we've outlined how we approach about being enterprise-grade.&#x20;

**General Information**

We use modern cloud architecture, programming techniques, and operational policies to stay ahead of the curve. No security plan is perfect but we take pride in making sure our customers feel like their app, users, and data is secure. We never access your personal data unless it's for support or account management. We never look at your unique app's configuration unless you've specifically given consent for us to do so. We never access your app's user data. We do, however, track this data holistically de-anonymized to improve our platform.&#x20;

We conduct annual penetration testing, vulnerability scans, and policy reviews to make sure we're up to date with standards.

**Service Level Terms**

The Services shall be available 99%, measured monthly, excluding holidays and weekends and scheduled maintenance. If a member requests maintenance during these hours, any uptime or downtime calculation will exclude periods affected by such maintenance. Further, any downtime resulting from outages of third party connections or utilities or other reasons beyond our control will also be excluded from any such calculation.

**Support Terms**

We'll will provide Support to members via e-mail on weekdays during the hours of 9:00 am through 5:00 pm Pacific time, with the exclusion of Federal Holidays ("Support Hours").\
\
Members may initiate a support ticket during Support Hours by emailing [support@hatchapps.com](mailto:info@pave.com). After-hours support may also be provided via email.\
\
We will use commercially reasonable efforts to respond to all support tickets within one (1) business day.

**Data Policy**

Records from our data systems including app data is completely de-identified from the individual and company before being being viewed for analytics purposes.\
\
Hatch Apps strictly does not sell any individual member data to another customer.

**Responsible Disclosure Policy**

Data security is a top priority for Hatch Apps, and we believe that working with skilled security researchers can identify weaknesses in any technology. If you believe you’ve found a security vulnerability in Hatch Apps' service, please notify us; we will work with you to resolve the issue promptly.\
\
If you believe you’ve discovered a potential vulnerability, please let us know by emailing us at [support@hatchapps.com](mailto:compliance@pave.com). We will acknowledge your email within 24 hours.\
\
Provide us with a reasonable amount of time to resolve the issue before disclosing it to the public or a third party. We aim to resolve critical issues within one week of disclosure.\
\
Make a good faith effort to avoid violating privacy, destroying data, or interrupting or degrading the Hatch Apps' service. Please only interact with accounts you own or for which you have explicit permission from the account holder.\
\
While researching, we’d like you to refrain from: Distributed Denial of Service (DDoS), Spamming, Social engineering, or phishing of Hatch Apps employees or contractors.

**Changes**

We may revise these guidelines from time to time. The most current version of the guidelines will be available here.

**Contact**

You can contact us with in app support or email us at <support@hatchapps.com>


# Overview

The Hatch Apps Mobile App Builder enables members to build an iOS and Android app without coding. The Mobile App Builder can be used with an API built with the API Builder or your own back end.&#x20;

Everything is customizable: components, user flows, screen layouts, and more.

Preview the app directly in the browser. Export the code to be able to deploy to iOS App Store or Google Play Store.&#x20;


# Components


# Hatch Apps Components


# Partner Components


# Deployments


# iOS App


# Android App


# Overview

The Hatch Apps API Builder enables members to build a back end, REST API, and database without coding. The API Builder can be used with or without an app built with our Mobile App Builder.&#x20;

Everything is customizable: API name, endpoints, objects, data schema, permissions, and more.&#x20;

Deployments happen with one click. After release, members can track data via API call or with a database viewer. All changes to the API configuration deploy instantly.&#x20;

<figure><img src="/files/oEcGCmusL2xIgyfCABDy" alt=""><figcaption></figcaption></figure>


# Getting started

In this section you'll learn how to quickly build and deploy your first REST API with the API Builder.&#x20;

### Create an API

* Go to the [API Builder Dashboard](https://console.hatchapps.com/dashboard) and click on Create A New API
* Enter a name for your API and a unique path
* Click Create to create the API

![](https://console.hatchapps.com/documentation//assets/images/createapi.PNG)

### Configure the API

On the next screen you'll be able to configure the object types that your API will manage through our API Editor. The default configuration defines a `Posts` resource with three properties and a permission rule that only allows the author of a note full access.

1. Click **Configure** to Configure your API.&#x20;
2. Click **Add Property** to Add your API Property.&#x20;
3. Click **Save** to deploy your API.&#x20;

&#x20;

![Create an API](https://console.hatchapps.com/documentation//assets/images/endpoint.PNG)

&#x20;<br>

![](https://console.hatchapps.com/documentation//assets/images/deploy.PNG)

***

<br>


# Test your API

After the deployment has completed, you'll see a modal with useful commands to test your API. For the following commands, replace `your api path` and `your api key` with your API path and the API key.&#x20;

Create a new post:

&#x20;`curl -H "Content-Type: application/json" \`\
`-H "API-TOKEN: your api key" \`\
`-d "{ \"Property\": \"value\"}" \`\
`https://console.hatchapps.com/api/your_api_path/endpoint`\
&#x20;

Here's an example:

&#x20;`curl -H "Content-Type: application/json" \`\
`-H "API-TOKEN: 26818869033657110" \`\
`-d "{ \"name\": \"testname\"}" \`\
`https://console.hatchapps.com/api/hatchappsapi/posts`\
&#x20;

We also provide a no-code way to test your API with our API Tester.&#x20;

That's it! You have successfully built and deployed your first API with Hatch Apps API Builder and created your first object.

<figure><img src="/files/V5qGQJ9PqNaHGhj1cS3P" alt=""><figcaption></figcaption></figure>


# List data

After configuring your endpoint, you'll see the list of methods to communicate with your endpoints. The first method is List Data. You can do this with a GET request as shown below. Replace `your api path, your api key,` and `your end point` with your API path, API key, and endpoint.&#x20;

List all data

&#x20;`curl -H "Accept: application/json" \`\
`-H "API-TOKEN: your api key" \`\
`https://console.hatchapps.com/api/ your api path/your endpoint`\ <br>

Here's an example

&#x20;`curl -H "Accept: application/json" \`\
`-H "API-TOKEN: 42270160762429063" \`\
`https://console.hatchapps.com/api/notes/test`\ <br>


# Create new data

You can create new data with a POST request as shown below. Replace `your api path, your api key,` and `your end point` with your API path, API key, and endpoint.&#x20;

* Create new data

&#x20;`curl -H "Content-Type: application/json" \`\
`-H "API-TOKEN: your api key" \`\
`-d "{ \"text\": \"Hello from HatchApps!\", \"author\": \"me\" }" \`\
`https://console.hatchapps.com/api/your api path/your endpoint`\ <br>

* Here's an Example

&#x20;`curl -H "Content-Type: application/json" \`\
`-H "API-TOKEN: 42270160762429063" \`\
`-d "{ \"text\": \"Hello from HatchApps!\", \"author\": \"me\" }" \`\
`https://console.hatchapps.com/api/notes/test`\ <br>


# Get data

You can get data with a GET request as shown below. Replace `your api path, your api key,` and `your end point` with your API path, API key, and endpoint.&#x20;

Get data

&#x20;`curl -H "Accept: application/json" \`\
`-H "API-TOKEN: your api key" \`\
`api/your api path/your endpoint path/data id`\
\
Here's an example

&#x20;`curl -H "Accept: application/json" \`\
`-H "API-TOKEN: 42270160762429063" \`\
`https://console.hatchapps.com/api/notes/test/635303154`\ <br>


# Update data

You can update data with a PUT request as shown below. Replace `your api path, your api key,` and `your end point` with your API path, API key, and endpoint.&#x20;

Update data

&#x20;`curl -X PUT -H "Content-Type: application/json" \ -H "API-TOKEN: your api key" \ -d "{ \"text\": \"Hi from hatchapps updated!\"}" \ https://console.hatchapps.com/api/your api path/your endpoint path/data id`<br>

Here's an Example

&#x20;`curl -X PUT -H "Content-Type: application/json" \ -H "API-TOKEN: 42270160762429063" \ -d "{ \"text\": \"Hi from hatchapps updated!\"}" \ https://console.hatchapps.com/api/notes/test/635303154`


# Delete data

You can get data with a DELETE request as shown below. Replace `your api path, your api key,` and `your end point` with your API path, API key, and endpoint.&#x20;

Update data

&#x20;`curl -X DELETE -H "Accept: application/json" \ -H "API-TOKEN: your api key" \ https://console.hatchapps.com/api/your api path/your endpoint path/data id`<br>

Here's an example

&#x20;`curl -X DELETE -H "Accept: application/json" \ -H "API-TOKEN: 42270160762429063" \ https://console.hatchapps.com/api/notes/test/635303154`<br>


# Postman

Many of our members use Postman to test their API.\
\
To export a collection:

1. Log in to the API Builder. &#x20;
2. Navigate to top right dropdown and select Postman.
3. You'll be taken to the Postman web application.&#x20;
4. Click on "Run in Postman" on the top right corner.&#x20;
5. If you have Postman running locally, click on your desired workspace.&#x20;
6. Click on "Import" to successfully import your created API collection to your local Postman app. <br>

To change variables: After successfully importing your collection, click on the Variable tab. Change the api\_key, id, base\_url & end\_point current value with your value's from the API Builder.&#x20;


# Database View

We provide members with a no-code database view and full control over their data.&#x20;

* View data: View your data in a spreadsheet-like interface with dynamic columns and rows based on how you defined the API.&#x20;
* Edit data: Click on the Edit button to change values.&#x20;
* Delete data: Click on the Delete button to delete values.&#x20;
* Import data: Import data from thousands of apps through our Zapier integration.&#x20;
* Export data: Export data to thousands of apps through our Zapier integration.&#x20;

<figure><img src="/files/HJdElpzRp2D91gHjR5H5" alt=""><figcaption></figcaption></figure>


# Permissions

You can configure endpoints to have specific permissions. This is helpful depending on the use case or security required by your company.&#x20;


# Admin

If you grant Admins to an endpoint, only the members that are an Admin on your Hatch Apps account have access. <br>

Steps to access an API as an Admin: <br>

1\. Log in using the credentials through `/apilogin` url by post method as shown below. Replace `your api key` with your API path and the API key. Replace `your email` with the email and `your password` with the password.

\
`curl -H "Content-Type: application/json" \`\
`-H "API-TOKEN: your api key" \`\
`-d "{ \"email\": \"your email \", \"password\": \"your password\" }" \`\
`https://console.hatchapps.com/api/apilogin`<br>

2\. In the response you'll get an authorization token. You'll then use this token in the header as the authorization key to access the endpoint. <br>

![Create an API
](https://console.hatchapps.com/documentation//assets/images/only_admin.png)


# Authorized users

If you grant Authorized Users to an endpoint, only the members you specified in your team can access it. <br>

Steps to access an API as an authorized user: <br>

1\. Log in using the credentials through `/apilogin` url by post method as shown below. Replace `your api key` with your API path and the API key. Replace `your email` with the email and `your password` with the password.

\
`curl -H "Content-Type: application/json" \`\
`-H "API-TOKEN: your api key" \`\
`-d "{ \"email\": \"your email \", \"password\": \"your password\" }" \`\
`https://console.hatchapps.com/api/apilogin`<br>

2\. In the response you'll get an authorization token. You'll then use this token in the header as the authorization key to access the endpoint. <br>

![Create an API](https://console.hatchapps.com/documentation//assets/images/authorized_users.png)

<br>


# Specified users

If you grant Specified Users to an endpoint, only the members you specified from the team list can access it with their credentials. <br>

Steps to access an API endpoint as a specific authorized user:&#x20;

1. Log in using the credentials through `/apilogin` url by post method as shown below. Replace `your api key` with your API path and the API key. Replace `your email` with the email and `your password` with the password.

\
`curl -H "Content-Type: application/json" \`\
`-H "API-TOKEN: your api key" \`\
`-d "{ \"email\": \"your email \", \"password\": \"your password\" }" \`\
`https://console.hatchapps.com/api/apilogin`<br>

2\. In the response you'll get an authorization token. You'll then use this token in the header as the authorization key to access the endpoint. <br>

![Create an API](https://console.hatchapps.com/documentation//assets/images/specified_users.png)


# Public access

If you grant Public Access to any endpoint, every authorized or unauthorized user can access it without the need of the `AUTHORIZATION` key in the header request.

![Create an API](https://console.hatchapps.com/documentation//assets/images/public_access.png)


# Integrations


# Zapier

### Connect Hatch Apps to hundreds of other apps with Zapier.[​](https://docs.climatebenefits.com/Integrations/Zapier#connect-climate-benefits-to-hundreds-of-other-apps-with-zapier) <a href="#connect-climate-benefits-to-hundreds-of-other-apps-with-zapier" id="connect-climate-benefits-to-hundreds-of-other-apps-with-zapier"></a>

[Zapier](https://zapier.com/apps/climate-benefits/integrations) lets you connect Hatch Apps to 2,000+ other web services. Automated connections called Zaps, set up in minutes with no coding, can automate your day-to-day tasks and build workflows between apps that otherwise wouldn't be possible.

Each Zap has one app as the **Trigger**, where your information comes from and which causes one or more **Actions** in other apps, where your data gets sent automatically.

### Getting Started with Zapier[​](https://docs.climatebenefits.com/Integrations/Zapier#getting-started-with-zapier) <a href="#getting-started-with-zapier" id="getting-started-with-zapier"></a>

Sign up for a free [Zapier](https://zapier.com/apps/climate-benefits/integrations) account, from there you can jump right in. To help you hit the ground running, here are some popular pre-made Zaps.

* [Connect your API to a Google Sheet. ](https://zapier.com/apps/hatch-apps/integrations/google-sheets)
* [Send an automated email when data is added to your API. ](https://zapier.com/apps/hatch-apps/integrations/gmail)
* [Send a Slack message when data is added to your API. ](https://zapier.com/apps/hatch-apps/integrations/slack)

### How do I connect Hatch Apps to Zapier?[​](https://docs.climatebenefits.com/Integrations/Zapier#how-do-i-connect-climate-benefits-to-zapier) <a href="#how-do-i-connect-climate-benefits-to-zapier" id="how-do-i-connect-climate-benefits-to-zapier"></a>

Log in to your [Zapier account](https://zapier.com/sign-up) or create a new account. Navigate to "My Apps" from the top menu bar. Now click on "Connect a new account..." and search for "Hatch Apps" Use your credentials to connect your Hatch Apps account to Zapier. Once that's done you can start creating an automation! Use a pre-made Zap or create your own with the Zap Editor. Creating a Zap requires no coding knowledge and you'll be walked step-by-step through the setup. Need inspiration? See everything that's possible with [Hatch Apps and Zapier](https://zapier.com/apps/hatch-apps/integrations).&#x20;

If you have any additional questions, you can reach out to <contact@zapier.com>.


# Overview

The Hatch Apps API Tester enables members to test an API in the browser without coding. Select your method, enter your URL, and customize parameters seamlessly. No third party software required.

<figure><img src="/files/Dxztk753vhMwXokLBKik" alt=""><figcaption></figcaption></figure>


# Test your API

To use the API Tester:&#x20;

1. Select your required method from the dropdown (it should say GET by default). We provide all required methods.&#x20;
2. Enter the url, api\_path, endpoint\_path & data ID.&#x20;
3. Select the Header tab to enter your API-TOKEN & AUTHORIZATION from the API Builder.&#x20;
4. Select the Body tab to enter your Form Data in order to create or update your API data.&#x20;

Note that the API Tester can be used by members for APIs built or not built with Hatch Apps.&#x20;

<br>

<figure><img src="/files/Fbnbqf1k5VI5fMZAYpK6" alt=""><figcaption></figcaption></figure>


# Overview

The Software Insurance product enables members to purchase insurance against their software development expense.&#x20;

We designed this product as a result of hundreds of horror stories we heard from our members about previous software development stories. When spending a substantial amount of company time and money, we believe there should be insurance in place to protect in case something goes wrong.&#x20;

The insurance costs $99 per month in premiums. There is only one rate for all members and no application is needed to participate.&#x20;

After 3 months of paying premiums, members can submit a claim in the platform. Payouts are given in the form of Hatch Apps marketplace credit. Credit can only be used within the platform, and not transferred for cash or other assets.&#x20;

<figure><img src="/files/i9rjo52HDCyEE6HRks0X" alt=""><figcaption></figcaption></figure>


# Submit a claim

To submit a claim, fill out the form here: <https://www.hatchapps.com/submit-claim>

Be sure to include as much detail as possible on the incident, stakeholders involved, and what went wrong. The form allows for unlimited file upload and we encourage members to be as detailed as possible.&#x20;

After you've submitted a claim, a member of our support team will reach out via email within 24 hours. Note that claims can take up to 10 business days to assess. Just like all insurance products, claims are assessed on a case by case basis.&#x20;


# Redeem credit

To view available marketplace credit:&#x20;

1. Go to the [Settings](https://platform.hatchapps.com/settings) page.&#x20;
2. Click on "Marketplace Credit".
3. You'll see the amount of available credit. Note that credit is assigned on a company-wide basis.&#x20;

To redeem marketplace credit:&#x20;

1. Go to the [Marketplace](https://platform.hatchapps.com/marketplace) page.&#x20;
2. Click on "Purchase" next to any service.&#x20;
3. In the modal, the "Amount" will reflect the marketplace service price minus the available credit.&#x20;
4. When you click "Pay Now", the card on file will be charged the amount shown. The Marketplace Credit page will also update.&#x20;


# Overview

Hatch Apps has the strongest no-code ecosystem on the market. Our members save time and money by accessing the full power of partners in the platform.

Below are the type of partners in our ecosystem.&#x20;

* **Integrations**: We partner with other software companies to enable members to build custom integrations.&#x20;
* **Marketplace**: We partner with agencies to provide custom development and implementation services to members.&#x20;
* **Deals**: We partner with other software companies to provide exclusive deals to members.&#x20;
* **VC Funds**: We partner with VC funds to give Hatch Apps to their portfolio companies at a discount.&#x20;
* **Accelerators**: We partner with accelerators and incubators to give Hatch Apps to their companies at a discount.&#x20;
* **Distributors**: We partner with Enterprises and Governments to distribute Hatch Apps globally on our behalf.&#x20;
* **Sponsors**: We partner with investors and philanthropies to sponsor students and non-profits.&#x20;
* **Affiliates**: We partner with creators and influencers to distribute Hatch Apps to their followers.&#x20;


# Marketplace guidelines

We provide guidelines for Marketplace partners to fulfill services to our members. Although these partners are third party vendors, we believe they represent Hatch Apps when working with customers.&#x20;

Workflow & Communication

* After a customer purchases a service, we automatically initiate an email between the member, partner, and Hatch Apps support.&#x20;
* We require that all communication remain on the email thread with <support@hatchapps.com> cc'd to ensure the Hatch Apps team can step in if needed.&#x20;
* Partners must be added by members to the platform as a Team member with the "Contractor" permission.&#x20;
* We recommend daily email communication during the course of the engagement.&#x20;

Payment

* Hatch Apps pays partners via wire transfer on the 1st of each month.&#x20;
* Partners receive 70% of the transaction, while Hatch Apps receives 30%.&#x20;
* We do not refund members on Marketplace purchases. All payments are final per our Terms & Conditions.&#x20;


