Documentation

This is Traity for Developers documentation. Here we provide access and documentation to Kevin API.

If you chat with Kevin, you'll see that a Kevin transaction happens through these atomic steps:

  • A transaction T is created by user U1
  • User U2 joins transaction T
  • User U1 writes a review or claim
  • User U2 writes a review or claim

However, we can be more specific if we consider the context where transactions take place (Kevin, Milanuncios, Truecalia, etc.):

  • User U1 gives permission to an app A to act on their behalf
  • User U2 gives permission to A to act on their behalf
  • A may query U1's reputation to show it to other users
  • A may query U2's reputation to show it to other users
  • A creates a transaction T on behalf of U1
  • A makes U2 join transaction T
  • A writes a review or claim about U2 on behalf or U1
  • A writes a review or claim about U1 on behalf of U2

For the case of using Kevin bot, A == Kevin.

Bear in mind that some of the actions might not be visible in the front-end. Creating a transaction, giving permissions, and joining the transaction, might all happen at the same time in the front-end, but they are multiple atomic actions.

For each of these atomic actions, there's an associated endpoint that can be used to trigger them.