README.md

Sample app: Create an individual contractor fixed-rate contract

This app showcases how a web application split into 2 projects can interact with Deel API to create a fixed-rate contract, sign it, and then invite a contractor to sign it.

The app has 2 projects:

• Client: Front-end application created using Create React App
• Server: Backend using Node.JS Express

Sample features

Create a contract

This page showcases how to create an individual contractor fixed-rate contract. It only includes the required fields to make the API call successfully. To create a contract:

1. Fill all the fields.
2. Click Create contract.

If the call is successful and alert will be displayed with the Contract ID. Make a note of it, because you can use that to sign the contract and invite the contractor to sign it.

More info:

• Guide
• Developer reference

Sign a contract

This page showcases how to sign a contract that was previously created. It only includes the required fields to make the API call successfully. To sign the contract:

1. Fill all the fields.
2. Click Sign contract.

If the call is successful an alert will be displayed.

More info:

• Guide
• Developer reference

Invite a contractor

This page showcases how to invite a contractor to sign a contract that you previously signed. It only includes the required fields to make the API call successfully. To invite a contractor:

1. Fill all the fields.
2. Click Invite contractor.

If the call is successful, an alert will be displayed.

More info:

• Guide
• Developer reference

Prerequisites

• A Deel API token. You can generate a new token following the instructions in API tokens.
• Node.js v18+.

Installing the dependencies

After installing Node.js and retrieving a valid token, you can install the dependencies:

1. Open a command-line window and navigate to to the sample directory samples/create-ic-fixed-rate-contract/.
2. Run npm install.
3. Then run npm run setup.

Environment variables

• API_HOST - Deel API URL that is used by application.
  • By default, we're using https://api-sandbox.demo.deel.com.
• API_TOKEN - Deel API token mentioned in Prerequisites.
  • The token should be generated in the same environment used by API_HOST.

Configure environment variables

• Save the API token generated in the variable API_TOKEN in /server/.env

How to run the project locally

Manually

1. Navigate to project directory samples/create-ic-fixed-rate-contract/client and run npm run start.
2. Navigate to the server directory with samples/create-ic-fixed-rate-contract/client and run npm run start.

A browser should open automatically at http://localhost:3098.

Using scripts

1. Navigate to the application directory samples/create-ic-fixed-rate-contract.
2. Run npm run start.

A browser should open automatically at http://localhost:3098.

Code samples

POST request to /rest/v2/contracts to create a new contract

const getHeaders = () => ({
    'Authorization': `Bearer ${process.env.API_TOKEN}`,
    'Content-Type': 'application/json'
});
app.post('/api/contracts', async (req, res) => {
    const payload = {
        data: {...}
    };
    
    try {
        const response = await axios.post(`${process.env.API_HOST}/rest/v2/contracts`, payload, {
            headers: getHeaders(),
        });
        res.json(response.data.data);
    } catch(err) {
        return handleError(err, res);
    }
});

POST request to /rest/v2/contracts/:id/signatures to sign a contract

  const payload = {
      data: {
          ...req.body
      }
  };
  const response = await axios.post(`${process.env.API_HOST}/rest/v2/contracts/${req.params.id}/signatures`, payload, {
      headers: getHeaders(),
  });
  res.json(response.data);

POST request to /rest/v2/contracts/:id/invitations to invite a contractor

  const payload = {
      data: {
          ...req.body
      }
  };
  const response = await axios.post(`${process.env.API_HOST}/rest/v2/contracts/${req.params.id}/invitations`, payload, {
      headers: getHeaders(),
  });
  res.json(response.data);