Deploying DeadLetter Learning DeadCL DeadCL Tutorials DeadCL Syntax DeadCL MBS

Walk throughs

Author Keys Conversations Libraries Arrays

  Network Status Community Hub Contact Us



Parcel V4 Basics

View Parcel overview

What is Parcel?

Simply put Parcel it the name given to the (API) available to input and output objects (resources, text & information) into your DeadLetter Conversation.

It's divided into two distinct parts CHAD (Configurable Helper for Author Directives) & Arnold a shared messaging API



Discussed below;

- Setting your Parcel Endpoints
- Authentication
- Rate Limits
- Security Reports


Creating a Parcel Endpoint

Before you're able to use Parcel you'll need to setup Parcel Endpoint(s). It's really simple requiring a single line within an Author Key (per endpoint).

Here we've created an endpoint with the URI; parcel.deadletter.io/v4/Parcel/CHAD/Do-ID+OWZbS-NR5B6-vAX3N


           

?DRP PARCEL- G C #Do-ID+OWZbS-NR5B6-vAX3N

You can create more than one endpoint, by appending the command within the Author Key as follows;

This sets the information received as LR5p6. Always use a random string for these values - for added security & to avoid conflicts.

You can assign the endpoint to either CHAD (C) or Arnold (A) by appending the request with CorAas shown.

Parcel Endpoints are permanent (they never expire). Although, they get flushed if you generate too many, are no longer actively using them or; remove them yourself, for security reasons. You can consider them safe for long-term purposes.
   

?DRP PARCEL- G C #Do-ID+OWZbS-NR5B6-vAX3N -- VAL_LR5p6

Authentication

Parcel Authentication can be performed using HTTP header signatures or basic HTTP Basic authentication. Both methods are not enforced by default, but available to enable fast and easy integration with secured systems.


1. HTTP Header signatures
2. HTTP Basic authentication

Using HTTP header signatures

Setting a header is very easy & yes it's done using your Author Key, by inserting the following command.

            
PARCEL- G H AUTH VAL_{'vAX3N'}

Using HTTP Basic authentication

Is much more involved you'll need to have an existing POST URI configured along with having a Trusted Author Key.


Authentication keys can be created as explained below:

1. Create a Conversation to run our generation command
2. You'll be provided with two keys 'Parcel' & 'Key' on the POST URI; keep them keys private!

Creating Authentication keys

Generating Keys is very easy, just connect the following Conversation to Your Author Key.

Prerequisites/Steps
1. Your AK is trusted & You're able to modify it
2. You have a URI capable of receiving using POST or PUT methods
3. Add a remote Conversation (as shown) this will POST a set of fresh keys for every Conversation permitted



            

trusted_Cnvrstn//@ID_ KEY_GENV2.0


Authentication keys are permanent (they never expire). Although, they get flushed if you generate too many of them, for security reasons. You can consider them safe for long-term purposes.

Removing (flushing) an Authentication Key

Removing keys is simple, you can either delete the Conversation (this in turn will flush the Keys or; remove them using the steps below.

Prerequisites/Steps
1. You have a the capability to perform a POST request (using either DRM or PARCEL)
2. Add a remote Conversation (as shown) this will remove any keys requested.
3. state which key(s) you'd like to remove.



            

trusted_Cnvrstn//@ID_ KEY_REMOVE_2018


Rate Limits

To ensure resiliency against DOS & enforce a fair-use policy, Parcel has a multi-level rate-limit.

If your client gets rate limited, you stop receiving information responses from Parcel. This can be global or per-route, based on how you triggered our rate-limiting systems.


1. Load rate limit - the rate limit on Parcel edge load balancers; it's very unlikely you'll reach this limit
2. Universal rate limit - Parcel wide rate limit that limits the total amount of requests a given IP & Author Key
3. Per Author rate limit - a more restrictive, per Author Key rate limit based on Parcel routes attached to an Author Key.

Security Reports

If you find any security hole in Parcel, you're more than welcome to report it directly to us, or better still help us patch it!



- email us [email protected]
- Join our Community