Awesome
<h1 align=center>Animl Ingest API</h1>Lambda-based API to support consuming cellular camera data via POST requests. Currently, the API only supports image payloads sent by Reconyx's servers.
About
The animl-ingest-api stack is a collection of AWS resources managed by the Serverless framework. When image payloads are received they are passed through to the Animl Ingest S3 bucket, managed by the Animl Ingest stack.
The Animal ingest API aims to be compatible with as many camera trap providers as possible and serve as an easier alternative to scraping image data out of email alerts, as we do in the Animl Email Relay service.
Setup
Prerequisites
The instructions below assume you have the following tools globally installed:
- Serverless
- Docker
- aws-cli
Create "animl" AWS config profile
The name of the profile must be "animl", because that's what
serverles.yml
will be looking for. Good instructions
here.
Make a project directory and clone this repo
git clone https://github.com/tnc-ca-geo/animl-ingest-api.git
cd animl-ingest-api/api
npm install
cd ..
Dev deployment
From project root folder (where serverless.yml
lives), run the following to deploy or update the stack:
# Deploy or update a development stack:
serverless deploy --stage dev
# Deploy or update a production stack:
serverless deploy --stage prod
Related repos
Animl is comprised of a number of microservices, most of which are managed in their own repositories.
Core services
Services necessary to run Animl:
Wireless camera services
Services related to ingesting and processing wireless camera trap data: