Plant Breeding API server

---

Plant Breeding API server implementation for Drupal.

===============================

CONTENTS OF THIS FILE

• Introduction
• Requirements
• Installation
• Configuration
• Administration
• Maintainers

INTRODUCTION

Version 4.0.x is a complete rewrite of the BrAPI module for Drupal 8+. This module only contains the BrAPI server part. For a Drupal BrAPI client, see External Entities BrAPI Storage plugin ( https://www.drupal.org/project/xnttbrapi/).

You can configure wich version of BrAPI your site support (1.x and/or 2.x). To enable a call, you need first to map all the data types it is using to Drupal content types. Then, you can enable the call. Each data type is related to a given BrAPI version and mappings are also version related.

BrAPI calls are handled through: /brapi/v<1 or 2>/[parameters such as: ?page=0&pageSize=10]

Current beta support: -calls for listing and displaying a single element (read only) -search calls -pager -filters -authentication -permissions are not fully managed (read only) -only JSON output

REQUIREMENTS

No Drupal module requirements. Requires composer package galbar/jsonpath (automatically installed by composer).

INSTALLATION

• Install as you would normally install a contributed Drupal module. Visit https://www.drupal.org/node/1897420 for further information.

• Setup your site services.yml file (copy "default/default.services.yml" into your site directory where your "settings.php" is, as "services.yml"). In "cors.config:" section, make sure it is enabled: "enabled: true". Then allow the headers: "allowedHeaders: ['authorization','content-type','accept','origin','access-control-allow-origin','x-allowed-header']". If you don't want to restrict sites using your BrAPI end point: "allowedOrigins: ['*']". For details, visit https://www.drupal.org/docs/drupal-apis/services-and-dependency-injection/structure-of-a-service-file

CONFIGURATION

Got to your site /brapi/admin/ page. From there, you can manage supported BrAPI version, data types mapping (/brapi/admin/datatypes) and enabled calls (/brapi/admin/calls). On the "people" > "permissions" page, got to the "Plant Breeding API" section and set the "Use BrAPI" permission to the appropriate roles. You may grant that permission to the "Anonymous" role for anonymous access.

ADMINISTRATION

• To manage user, use Drupal native user management interface.

• To get a user access token, login to the website using the user account and visit /brapi/token/new.

• To clear search cache, use drush command:

drush cc bin brapi_search

MAINTAINERS

Current maintainers:

• Valentin Guignon (guignonv) - https://www.drupal.org/u/guignonv